Class RoutingParameter

  • All Implemented Interfaces:
    RoutingParameterOrBuilder, 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 RoutingParameter
    extends com.google.protobuf.GeneratedMessageV3
    implements RoutingParameterOrBuilder
     A projection from an input message to the GRPC or REST header.
     
    Protobuf type google.api.RoutingParameter
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RoutingParameter.Builder
      A projection from an input message to the GRPC or REST header.
      • 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
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int FIELD_FIELD_NUMBER  
      static int PATH_TEMPLATE_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessage

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

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

        memoizedHashCode
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static RoutingParameter getDefaultInstance()  
      RoutingParameter getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getField()
      A request field to extract the header key-value pair from.
      com.google.protobuf.ByteString getFieldBytes()
      A request field to extract the header key-value pair from.
      com.google.protobuf.Parser<RoutingParameter> getParserForType()  
      java.lang.String getPathTemplate()
      A pattern matching the key-value field.
      com.google.protobuf.ByteString getPathTemplateBytes()
      A pattern matching the key-value field.
      int getSerializedSize()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static RoutingParameter.Builder newBuilder()  
      static RoutingParameter.Builder newBuilder​(RoutingParameter prototype)  
      RoutingParameter.Builder newBuilderForType()  
      protected RoutingParameter.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static RoutingParameter parseDelimitedFrom​(java.io.InputStream input)  
      static RoutingParameter parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RoutingParameter parseFrom​(byte[] data)  
      static RoutingParameter parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RoutingParameter parseFrom​(com.google.protobuf.ByteString data)  
      static RoutingParameter parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RoutingParameter parseFrom​(com.google.protobuf.CodedInputStream input)  
      static RoutingParameter parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RoutingParameter parseFrom​(java.io.InputStream input)  
      static RoutingParameter parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static RoutingParameter parseFrom​(java.nio.ByteBuffer data)  
      static RoutingParameter parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<RoutingParameter> parser()  
      RoutingParameter.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
    • 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
      • getField

        public java.lang.String getField()
         A request field to extract the header key-value pair from.
         
        string field = 1;
        Specified by:
        getField in interface RoutingParameterOrBuilder
        Returns:
        The field.
      • getFieldBytes

        public com.google.protobuf.ByteString getFieldBytes()
         A request field to extract the header key-value pair from.
         
        string field = 1;
        Specified by:
        getFieldBytes in interface RoutingParameterOrBuilder
        Returns:
        The bytes for field.
      • getPathTemplate

        public java.lang.String getPathTemplate()
         A pattern matching the key-value field. Optional.
         If not specified, the whole field specified in the `field` field will be
         taken as value, and its name used as key. If specified, it MUST contain
         exactly one named segment (along with any number of unnamed segments) The
         pattern will be matched over the field specified in the `field` field, then
         if the match is successful:
         - the name of the single named segment will be used as a header name,
         - the match value of the segment will be used as a header value;
         if the match is NOT successful, nothing will be sent.
        
         Example:
        
                       -- This is a field in the request message
                      |   that the header value will be extracted from.
                      |
                      |                     -- This is the key name in the
                      |                    |   routing header.
                      V                    |
             field: "table_name"           v
             path_template: "projects/*/{table_location=instances/*}/tables/*"
                                                        ^            ^
                                                        |            |
               In the {} brackets is the pattern that --             |
               specifies what to extract from the                    |
               field as a value to be sent.                          |
                                                                     |
              The string in the field must match the whole pattern --
              before brackets, inside brackets, after brackets.
        
         When looking at this specific example, we can see that:
         - A key-value pair with the key `table_location`
           and the value matching `instances/*` should be added
           to the x-goog-request-params routing header.
         - The value is extracted from the request message's `table_name` field
           if it matches the full pattern specified:
           `projects/*/instances/*/tables/*`.
        
         **NB:** If the `path_template` field is not provided, the key name is
         equal to the field name, and the whole field should be sent as a value.
         This makes the pattern for the field and the value functionally equivalent
         to `**`, and the configuration
        
             {
               field: "table_name"
             }
        
         is a functionally equivalent shorthand to:
        
             {
               field: "table_name"
               path_template: "{table_name=**}"
             }
        
         See Example 1 for more details.
         
        string path_template = 2;
        Specified by:
        getPathTemplate in interface RoutingParameterOrBuilder
        Returns:
        The pathTemplate.
      • getPathTemplateBytes

        public com.google.protobuf.ByteString getPathTemplateBytes()
         A pattern matching the key-value field. Optional.
         If not specified, the whole field specified in the `field` field will be
         taken as value, and its name used as key. If specified, it MUST contain
         exactly one named segment (along with any number of unnamed segments) The
         pattern will be matched over the field specified in the `field` field, then
         if the match is successful:
         - the name of the single named segment will be used as a header name,
         - the match value of the segment will be used as a header value;
         if the match is NOT successful, nothing will be sent.
        
         Example:
        
                       -- This is a field in the request message
                      |   that the header value will be extracted from.
                      |
                      |                     -- This is the key name in the
                      |                    |   routing header.
                      V                    |
             field: "table_name"           v
             path_template: "projects/*/{table_location=instances/*}/tables/*"
                                                        ^            ^
                                                        |            |
               In the {} brackets is the pattern that --             |
               specifies what to extract from the                    |
               field as a value to be sent.                          |
                                                                     |
              The string in the field must match the whole pattern --
              before brackets, inside brackets, after brackets.
        
         When looking at this specific example, we can see that:
         - A key-value pair with the key `table_location`
           and the value matching `instances/*` should be added
           to the x-goog-request-params routing header.
         - The value is extracted from the request message's `table_name` field
           if it matches the full pattern specified:
           `projects/*/instances/*/tables/*`.
        
         **NB:** If the `path_template` field is not provided, the key name is
         equal to the field name, and the whole field should be sent as a value.
         This makes the pattern for the field and the value functionally equivalent
         to `**`, and the configuration
        
             {
               field: "table_name"
             }
        
         is a functionally equivalent shorthand to:
        
             {
               field: "table_name"
               path_template: "{table_name=**}"
             }
        
         See Example 1 for more details.
         
        string path_template = 2;
        Specified by:
        getPathTemplateBytes in interface RoutingParameterOrBuilder
        Returns:
        The bytes for pathTemplate.
      • 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 RoutingParameter parseFrom​(java.nio.ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        public com.google.protobuf.Parser<RoutingParameter> 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 RoutingParameter 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