Package com.google.rpc.context

Class AttributeContext

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<AttributeContext,AttributeContext.Builder>
com.google.rpc.context.AttributeContext
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, AttributeContextOrBuilder
public final class AttributeContext extends com.google.protobuf.GeneratedMessageLite<AttributeContext,AttributeContext.Builder> implements AttributeContextOrBuilder
 This message defines the standard attribute vocabulary for Google APIs.

 An attribute is a piece of metadata that describes an activity on a network
 service. For example, the size of an HTTP request, or the status code of
 an HTTP response.

 Each attribute has a type and a name, which is logically defined as
 a proto message field in `AttributeContext`. The field type becomes the
 attribute type, and the field path becomes the attribute name. For example,
 the attribute `source.ip` maps to field `AttributeContext.source.ip`.

 This message definition is guaranteed not to have any wire breaking change.
 So you can use it directly for passing attributes across different systems.

 NOTE: Different system may generate different subset of attributes. Please
 verify the system specification before relying on an attribute generated
 a system.
Protobuf type google.rpc.context.AttributeContext

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AttributeContext.Api
    This message defines attributes associated with API operations, such as a network API request.
    static interface 
    AttributeContext.ApiOrBuilder
     
    static final class 
    AttributeContext.Auth
    This message defines request authentication attributes.
    static interface 
    AttributeContext.AuthOrBuilder
     
    static final class 
    AttributeContext.Builder
    This message defines the standard attribute vocabulary for Google APIs.
    static final class 
    AttributeContext.Peer
    This message defines attributes for a node that handles a network request.
    static interface 
    AttributeContext.PeerOrBuilder
     
    static final class 
    AttributeContext.Request
    This message defines attributes for an HTTP request.
    static interface 
    AttributeContext.RequestOrBuilder
     
    static final class 
    AttributeContext.Resource
    This message defines core attributes for a resource.
    static interface 
    AttributeContext.ResourceOrBuilder
     
    static final class 
    AttributeContext.Response
    This message defines attributes for a typical network response.
    static interface 
    AttributeContext.ResponseOrBuilder
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    API_FIELD_NUMBER
     
    static final int
    DESTINATION_FIELD_NUMBER
     
    static final int
    EXTENSIONS_FIELD_NUMBER
     
    static final int
    ORIGIN_FIELD_NUMBER
     
    static final int
    REQUEST_FIELD_NUMBER
     
    static final int
    RESOURCE_FIELD_NUMBER
     
    static final int
    RESPONSE_FIELD_NUMBER
     
    static final int
    SOURCE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    AttributeContext.Api
    getApi()
    Represents an API operation that is involved to a network activity.
    static AttributeContext
    getDefaultInstance()
     
    AttributeContext.Peer
    getDestination()
    The destination of a network activity, such as accepting a TCP connection.
    com.google.protobuf.Any
    getExtensions(int index)
    Supports extensions for advanced use cases, such as logs and metrics.
    int
    getExtensionsCount()
    Supports extensions for advanced use cases, such as logs and metrics.
    List<com.google.protobuf.Any>
    getExtensionsList()
    Supports extensions for advanced use cases, such as logs and metrics.
    com.google.protobuf.AnyOrBuilder
    getExtensionsOrBuilder(int index)
    Supports extensions for advanced use cases, such as logs and metrics.
    List<? extends com.google.protobuf.AnyOrBuilder>
    getExtensionsOrBuilderList()
    Supports extensions for advanced use cases, such as logs and metrics.
    AttributeContext.Peer
    getOrigin()
    The origin of a network activity.
    AttributeContext.Request
    getRequest()
    Represents a network request, such as an HTTP request.
    AttributeContext.Resource
    getResource()
    Represents a target resource that is involved with a network activity.
    AttributeContext.Response
    getResponse()
    Represents a network response, such as an HTTP response.
    AttributeContext.Peer
    getSource()
    The source of a network activity, such as starting a TCP connection.
    boolean
    hasApi()
    Represents an API operation that is involved to a network activity.
    boolean
    hasDestination()
    The destination of a network activity, such as accepting a TCP connection.
    boolean
    hasOrigin()
    The origin of a network activity.
    boolean
    hasRequest()
    Represents a network request, such as an HTTP request.
    boolean
    hasResource()
    Represents a target resource that is involved with a network activity.
    boolean
    hasResponse()
    Represents a network response, such as an HTTP response.
    boolean
    hasSource()
    The source of a network activity, such as starting a TCP connection.
    static AttributeContext.Builder
    newBuilder()
     
    static AttributeContext.Builder
    newBuilder(AttributeContext prototype)
     
    static AttributeContext
    parseDelimitedFrom(InputStream input)
     
    static AttributeContext
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AttributeContext
    parseFrom(byte[] data)
     
    static AttributeContext
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AttributeContext
    parseFrom(com.google.protobuf.ByteString data)
     
    static AttributeContext
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AttributeContext
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static AttributeContext
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AttributeContext
    parseFrom(InputStream input)
     
    static AttributeContext
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AttributeContext
    parseFrom(ByteBuffer data)
     
    static AttributeContext
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<AttributeContext>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

  • Method Details

    • hasOrigin

      public boolean hasOrigin()
       The origin of a network activity. In a multi hop network activity,
 the origin represents the sender of the first hop. For the first hop,
 the `source` and the `origin` must have the same content.
      .google.rpc.context.AttributeContext.Peer origin = 7 [json_name = "origin"];
      Specified by:
      hasOrigin in interface AttributeContextOrBuilder
      Returns:
      Whether the origin field is set.

    • getOrigin

      public AttributeContext.Peer getOrigin()
       The origin of a network activity. In a multi hop network activity,
 the origin represents the sender of the first hop. For the first hop,
 the `source` and the `origin` must have the same content.
      .google.rpc.context.AttributeContext.Peer origin = 7 [json_name = "origin"];
      Specified by:
      getOrigin in interface AttributeContextOrBuilder
      Returns:
      The origin.

    • hasSource

      public boolean hasSource()
       The source of a network activity, such as starting a TCP connection.
 In a multi hop network activity, the source represents the sender of the
 last hop.
      .google.rpc.context.AttributeContext.Peer source = 1 [json_name = "source"];
      Specified by:
      hasSource in interface AttributeContextOrBuilder
      Returns:
      Whether the source field is set.

    • getSource

      public AttributeContext.Peer getSource()
       The source of a network activity, such as starting a TCP connection.
 In a multi hop network activity, the source represents the sender of the
 last hop.
      .google.rpc.context.AttributeContext.Peer source = 1 [json_name = "source"];
      Specified by:
      getSource in interface AttributeContextOrBuilder
      Returns:
      The source.

    • hasDestination

      public boolean hasDestination()
       The destination of a network activity, such as accepting a TCP connection.
 In a multi hop network activity, the destination represents the receiver of
 the last hop.
      .google.rpc.context.AttributeContext.Peer destination = 2 [json_name = "destination"];
      Specified by:
      hasDestination in interface AttributeContextOrBuilder
      Returns:
      Whether the destination field is set.

    • getDestination

      public AttributeContext.Peer getDestination()
       The destination of a network activity, such as accepting a TCP connection.
 In a multi hop network activity, the destination represents the receiver of
 the last hop.
      .google.rpc.context.AttributeContext.Peer destination = 2 [json_name = "destination"];
      Specified by:
      getDestination in interface AttributeContextOrBuilder
      Returns:
      The destination.

    • hasRequest

      public boolean hasRequest()
       Represents a network request, such as an HTTP request.
      .google.rpc.context.AttributeContext.Request request = 3 [json_name = "request"];
      Specified by:
      hasRequest in interface AttributeContextOrBuilder
      Returns:
      Whether the request field is set.

    • getRequest

      public AttributeContext.Request getRequest()
       Represents a network request, such as an HTTP request.
      .google.rpc.context.AttributeContext.Request request = 3 [json_name = "request"];
      Specified by:
      getRequest in interface AttributeContextOrBuilder
      Returns:
      The request.

    • hasResponse

      public boolean hasResponse()
       Represents a network response, such as an HTTP response.
      .google.rpc.context.AttributeContext.Response response = 4 [json_name = "response"];
      Specified by:
      hasResponse in interface AttributeContextOrBuilder
      Returns:
      Whether the response field is set.

    • getResponse

      public AttributeContext.Response getResponse()
       Represents a network response, such as an HTTP response.
      .google.rpc.context.AttributeContext.Response response = 4 [json_name = "response"];
      Specified by:
      getResponse in interface AttributeContextOrBuilder
      Returns:
      The response.

    • hasResource

      public boolean hasResource()
       Represents a target resource that is involved with a network activity.
 If multiple resources are involved with an activity, this must be the
 primary one.
      .google.rpc.context.AttributeContext.Resource resource = 5 [json_name = "resource"];
      Specified by:
      hasResource in interface AttributeContextOrBuilder
      Returns:
      Whether the resource field is set.

    • getResource

      public AttributeContext.Resource getResource()
       Represents a target resource that is involved with a network activity.
 If multiple resources are involved with an activity, this must be the
 primary one.
      .google.rpc.context.AttributeContext.Resource resource = 5 [json_name = "resource"];
      Specified by:
      getResource in interface AttributeContextOrBuilder
      Returns:
      The resource.

    • hasApi

      public boolean hasApi()
       Represents an API operation that is involved to a network activity.
      .google.rpc.context.AttributeContext.Api api = 6 [json_name = "api"];
      Specified by:
      hasApi in interface AttributeContextOrBuilder
      Returns:
      Whether the api field is set.

    • getApi

      public AttributeContext.Api getApi()
       Represents an API operation that is involved to a network activity.
      .google.rpc.context.AttributeContext.Api api = 6 [json_name = "api"];
      Specified by:
      getApi in interface AttributeContextOrBuilder
      Returns:
      The api.

    • getExtensionsList

      public List<com.google.protobuf.Any> getExtensionsList()
       Supports extensions for advanced use cases, such as logs and metrics.
      repeated .google.protobuf.Any extensions = 8 [json_name = "extensions"];
      Specified by:
      getExtensionsList in interface AttributeContextOrBuilder

    • getExtensionsOrBuilderList

      public List<? extends com.google.protobuf.AnyOrBuilder> getExtensionsOrBuilderList()
       Supports extensions for advanced use cases, such as logs and metrics.
      repeated .google.protobuf.Any extensions = 8 [json_name = "extensions"];

    • getExtensionsCount

      public int getExtensionsCount()
       Supports extensions for advanced use cases, such as logs and metrics.
      repeated .google.protobuf.Any extensions = 8 [json_name = "extensions"];
      Specified by:
      getExtensionsCount in interface AttributeContextOrBuilder

    • getExtensions

      public com.google.protobuf.Any getExtensions(int index)
       Supports extensions for advanced use cases, such as logs and metrics.
      repeated .google.protobuf.Any extensions = 8 [json_name = "extensions"];
      Specified by:
      getExtensions in interface AttributeContextOrBuilder

    • getExtensionsOrBuilder

      public com.google.protobuf.AnyOrBuilder getExtensionsOrBuilder(int index)
       Supports extensions for advanced use cases, such as logs and metrics.
      repeated .google.protobuf.Any extensions = 8 [json_name = "extensions"];

    • parseFrom

      public static AttributeContext parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AttributeContext parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AttributeContext parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AttributeContext parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AttributeContext parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AttributeContext parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AttributeContext parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AttributeContext parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AttributeContext parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AttributeContext parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AttributeContext parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AttributeContext parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilder

      public static AttributeContext.Builder newBuilder()

    • newBuilder

      public static AttributeContext.Builder newBuilder(AttributeContext prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<AttributeContext,AttributeContext.Builder>

    • getDefaultInstance

      public static AttributeContext getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AttributeContext> parser()