Class ContextRule

  • All Implemented Interfaces:
    ContextRuleOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

    public final class ContextRule
    extends com.google.protobuf.GeneratedMessageV3
    implements ContextRuleOrBuilder
     A context rule provides information about the context for an individual API
     element.
     
    Protobuf type google.api.ContextRule
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ContextRule.Builder
      A context rule provides information about the context for an individual API element.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

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

        com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getAllowedRequestExtensions​(int index)
      A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
      com.google.protobuf.ByteString getAllowedRequestExtensionsBytes​(int index)
      A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
      int getAllowedRequestExtensionsCount()
      A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
      com.google.protobuf.ProtocolStringList getAllowedRequestExtensionsList()
      A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend.
      java.lang.String getAllowedResponseExtensions​(int index)
      A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
      com.google.protobuf.ByteString getAllowedResponseExtensionsBytes​(int index)
      A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
      int getAllowedResponseExtensionsCount()
      A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
      com.google.protobuf.ProtocolStringList getAllowedResponseExtensionsList()
      A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client.
      static ContextRule getDefaultInstance()  
      ContextRule getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<ContextRule> getParserForType()  
      java.lang.String getProvided​(int index)
      A list of full type names of provided contexts.
      com.google.protobuf.ByteString getProvidedBytes​(int index)
      A list of full type names of provided contexts.
      int getProvidedCount()
      A list of full type names of provided contexts.
      com.google.protobuf.ProtocolStringList getProvidedList()
      A list of full type names of provided contexts.
      java.lang.String getRequested​(int index)
      A list of full type names of requested contexts, only the requested context will be made available to the backend.
      com.google.protobuf.ByteString getRequestedBytes​(int index)
      A list of full type names of requested contexts, only the requested context will be made available to the backend.
      int getRequestedCount()
      A list of full type names of requested contexts, only the requested context will be made available to the backend.
      com.google.protobuf.ProtocolStringList getRequestedList()
      A list of full type names of requested contexts, only the requested context will be made available to the backend.
      java.lang.String getSelector()
      Selects the methods to which this rule applies.
      com.google.protobuf.ByteString getSelectorBytes()
      Selects the methods to which this rule applies.
      int getSerializedSize()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static ContextRule.Builder newBuilder()  
      static ContextRule.Builder newBuilder​(ContextRule prototype)  
      ContextRule.Builder newBuilderForType()  
      protected ContextRule.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static ContextRule parseDelimitedFrom​(java.io.InputStream input)  
      static ContextRule parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ContextRule parseFrom​(byte[] data)  
      static ContextRule parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ContextRule parseFrom​(com.google.protobuf.ByteString data)  
      static ContextRule parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ContextRule parseFrom​(com.google.protobuf.CodedInputStream input)  
      static ContextRule parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ContextRule parseFrom​(java.io.InputStream input)  
      static ContextRule parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ContextRule parseFrom​(java.nio.ByteBuffer data)  
      static ContextRule parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<ContextRule> parser()  
      ContextRule.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType
      • Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter
      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashFields, toString
      • 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.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • Field Detail

      • ALLOWED_REQUEST_EXTENSIONS_FIELD_NUMBER

        public static final int ALLOWED_REQUEST_EXTENSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ALLOWED_RESPONSE_EXTENSIONS_FIELD_NUMBER

        public static final int ALLOWED_RESPONSE_EXTENSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

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

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Overrides:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getSelector

        public java.lang.String getSelector()
         Selects the methods to which this rule applies.
        
         Refer to [selector][google.api.DocumentationRule.selector] for syntax
         details.
         
        string selector = 1;
        Specified by:
        getSelector in interface ContextRuleOrBuilder
        Returns:
        The selector.
      • getSelectorBytes

        public com.google.protobuf.ByteString getSelectorBytes()
         Selects the methods to which this rule applies.
        
         Refer to [selector][google.api.DocumentationRule.selector] for syntax
         details.
         
        string selector = 1;
        Specified by:
        getSelectorBytes in interface ContextRuleOrBuilder
        Returns:
        The bytes for selector.
      • getRequestedList

        public com.google.protobuf.ProtocolStringList getRequestedList()
         A list of full type names of requested contexts, only the requested context
         will be made available to the backend.
         
        repeated string requested = 2;
        Specified by:
        getRequestedList in interface ContextRuleOrBuilder
        Returns:
        A list containing the requested.
      • getRequestedCount

        public int getRequestedCount()
         A list of full type names of requested contexts, only the requested context
         will be made available to the backend.
         
        repeated string requested = 2;
        Specified by:
        getRequestedCount in interface ContextRuleOrBuilder
        Returns:
        The count of requested.
      • getRequested

        public java.lang.String getRequested​(int index)
         A list of full type names of requested contexts, only the requested context
         will be made available to the backend.
         
        repeated string requested = 2;
        Specified by:
        getRequested in interface ContextRuleOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The requested at the given index.
      • getRequestedBytes

        public com.google.protobuf.ByteString getRequestedBytes​(int index)
         A list of full type names of requested contexts, only the requested context
         will be made available to the backend.
         
        repeated string requested = 2;
        Specified by:
        getRequestedBytes in interface ContextRuleOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the requested at the given index.
      • getProvidedList

        public com.google.protobuf.ProtocolStringList getProvidedList()
         A list of full type names of provided contexts. It is used to support
         propagating HTTP headers and ETags from the response extension.
         
        repeated string provided = 3;
        Specified by:
        getProvidedList in interface ContextRuleOrBuilder
        Returns:
        A list containing the provided.
      • getProvidedCount

        public int getProvidedCount()
         A list of full type names of provided contexts. It is used to support
         propagating HTTP headers and ETags from the response extension.
         
        repeated string provided = 3;
        Specified by:
        getProvidedCount in interface ContextRuleOrBuilder
        Returns:
        The count of provided.
      • getProvided

        public java.lang.String getProvided​(int index)
         A list of full type names of provided contexts. It is used to support
         propagating HTTP headers and ETags from the response extension.
         
        repeated string provided = 3;
        Specified by:
        getProvided in interface ContextRuleOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The provided at the given index.
      • getProvidedBytes

        public com.google.protobuf.ByteString getProvidedBytes​(int index)
         A list of full type names of provided contexts. It is used to support
         propagating HTTP headers and ETags from the response extension.
         
        repeated string provided = 3;
        Specified by:
        getProvidedBytes in interface ContextRuleOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the provided at the given index.
      • getAllowedRequestExtensionsList

        public com.google.protobuf.ProtocolStringList getAllowedRequestExtensionsList()
         A list of full type names or extension IDs of extensions allowed in grpc
         side channel from client to backend.
         
        repeated string allowed_request_extensions = 4;
        Specified by:
        getAllowedRequestExtensionsList in interface ContextRuleOrBuilder
        Returns:
        A list containing the allowedRequestExtensions.
      • getAllowedRequestExtensionsCount

        public int getAllowedRequestExtensionsCount()
         A list of full type names or extension IDs of extensions allowed in grpc
         side channel from client to backend.
         
        repeated string allowed_request_extensions = 4;
        Specified by:
        getAllowedRequestExtensionsCount in interface ContextRuleOrBuilder
        Returns:
        The count of allowedRequestExtensions.
      • getAllowedRequestExtensions

        public java.lang.String getAllowedRequestExtensions​(int index)
         A list of full type names or extension IDs of extensions allowed in grpc
         side channel from client to backend.
         
        repeated string allowed_request_extensions = 4;
        Specified by:
        getAllowedRequestExtensions in interface ContextRuleOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The allowedRequestExtensions at the given index.
      • getAllowedRequestExtensionsBytes

        public com.google.protobuf.ByteString getAllowedRequestExtensionsBytes​(int index)
         A list of full type names or extension IDs of extensions allowed in grpc
         side channel from client to backend.
         
        repeated string allowed_request_extensions = 4;
        Specified by:
        getAllowedRequestExtensionsBytes in interface ContextRuleOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the allowedRequestExtensions at the given index.
      • getAllowedResponseExtensionsList

        public com.google.protobuf.ProtocolStringList getAllowedResponseExtensionsList()
         A list of full type names or extension IDs of extensions allowed in grpc
         side channel from backend to client.
         
        repeated string allowed_response_extensions = 5;
        Specified by:
        getAllowedResponseExtensionsList in interface ContextRuleOrBuilder
        Returns:
        A list containing the allowedResponseExtensions.
      • getAllowedResponseExtensionsCount

        public int getAllowedResponseExtensionsCount()
         A list of full type names or extension IDs of extensions allowed in grpc
         side channel from backend to client.
         
        repeated string allowed_response_extensions = 5;
        Specified by:
        getAllowedResponseExtensionsCount in interface ContextRuleOrBuilder
        Returns:
        The count of allowedResponseExtensions.
      • getAllowedResponseExtensions

        public java.lang.String getAllowedResponseExtensions​(int index)
         A list of full type names or extension IDs of extensions allowed in grpc
         side channel from backend to client.
         
        repeated string allowed_response_extensions = 5;
        Specified by:
        getAllowedResponseExtensions in interface ContextRuleOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The allowedResponseExtensions at the given index.
      • getAllowedResponseExtensionsBytes

        public com.google.protobuf.ByteString getAllowedResponseExtensionsBytes​(int index)
         A list of full type names or extension IDs of extensions allowed in grpc
         side channel from backend to client.
         
        repeated string allowed_response_extensions = 5;
        Specified by:
        getAllowedResponseExtensionsBytes in interface ContextRuleOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the allowedResponseExtensions at the given index.
      • isInitialized

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

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

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

        public boolean equals​(java.lang.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 ContextRule parseFrom​(java.nio.ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

        public static ContextRule parseFrom​(java.io.InputStream input)
                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static ContextRule parseFrom​(java.io.InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static ContextRule parseDelimitedFrom​(java.io.InputStream input)
                                              throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static ContextRule parseDelimitedFrom​(java.io.InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static ContextRule parseFrom​(com.google.protobuf.CodedInputStream input)
                                     throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

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

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

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

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

        public static ContextRule getDefaultInstance()
      • parser

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

        public com.google.protobuf.Parser<ContextRule> 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.GeneratedMessage
      • getDefaultInstanceForType

        public ContextRule getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder