Class Context

  • All Implemented Interfaces:
    ContextOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class Context
    extends com.google.protobuf.GeneratedMessageV3
    implements ContextOrBuilder
     `Context` defines which contexts an API requests.
     Example:
         context:
           rules:
           - selector: "*"
             requested:
             - google.rpc.context.ProjectContext
             - google.rpc.context.OriginContext
     The above specifies that all methods in the API request
     `google.rpc.context.ProjectContext` and
     `google.rpc.context.OriginContext`.
     Available context types are defined in package
     `google.rpc.context`.
     This also provides mechanism to allowlist any protobuf message extension that
     can be sent in grpc metadata using “x-goog-ext-<extension_id>-bin” and
     “x-goog-ext-<extension_id>-jspb” format. For example, list any service
     specific protobuf types that can appear in grpc metadata as follows in your
     yaml file:
     Example:
         context:
           rules:
            - selector: "google.example.library.v1.LibraryService.CreateBook"
              allowed_request_extensions:
              - google.foo.v1.NewExtension
              allowed_response_extensions:
              - google.foo.v1.NewExtension
     You can also specify extension ID instead of fully qualified extension name
     here.
     
    Protobuf type google.api.Context
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Context.Builder
      `Context` defines which contexts an API requests.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int RULES_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getRulesList

        public List<ContextRule> getRulesList()
         A list of RPC context rules that apply to individual API methods.
         **NOTE:** All service configuration rules follow "last one wins" order.
         
        repeated .google.api.ContextRule rules = 1;
        Specified by:
        getRulesList in interface ContextOrBuilder
      • getRulesOrBuilderList

        public List<? extends ContextRuleOrBuilder> getRulesOrBuilderList()
         A list of RPC context rules that apply to individual API methods.
         **NOTE:** All service configuration rules follow "last one wins" order.
         
        repeated .google.api.ContextRule rules = 1;
        Specified by:
        getRulesOrBuilderList in interface ContextOrBuilder
      • getRulesCount

        public int getRulesCount()
         A list of RPC context rules that apply to individual API methods.
         **NOTE:** All service configuration rules follow "last one wins" order.
         
        repeated .google.api.ContextRule rules = 1;
        Specified by:
        getRulesCount in interface ContextOrBuilder
      • getRules

        public ContextRule getRules​(int index)
         A list of RPC context rules that apply to individual API methods.
         **NOTE:** All service configuration rules follow "last one wins" order.
         
        repeated .google.api.ContextRule rules = 1;
        Specified by:
        getRules in interface ContextOrBuilder
      • getRulesOrBuilder

        public ContextRuleOrBuilder getRulesOrBuilder​(int index)
         A list of RPC context rules that apply to individual API methods.
         **NOTE:** All service configuration rules follow "last one wins" order.
         
        repeated .google.api.ContextRule rules = 1;
        Specified by:
        getRulesOrBuilder in interface ContextOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static Context parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static Context parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static Context parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException
      • newBuilderForType

        public Context.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public Context.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected Context.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static Context getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Context> parser()
      • getParserForType

        public com.google.protobuf.Parser<Context> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public Context getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder