Class RoutingParameter (2.37.1)

public final class RoutingParameter extends GeneratedMessageV3 implements RoutingParameterOrBuilder

A projection from an input message to the GRPC or REST header.

Protobuf type google.api.RoutingParameter

Static Fields

FIELD_FIELD_NUMBER

public static final int FIELD_FIELD_NUMBER
Field Value
TypeDescription
int

PATH_TEMPLATE_FIELD_NUMBER

public static final int PATH_TEMPLATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RoutingParameter getDefaultInstance()
Returns
TypeDescription
RoutingParameter

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RoutingParameter.Builder newBuilder()
Returns
TypeDescription
RoutingParameter.Builder

newBuilder(RoutingParameter prototype)

public static RoutingParameter.Builder newBuilder(RoutingParameter prototype)
Parameter
NameDescription
prototypeRoutingParameter
Returns
TypeDescription
RoutingParameter.Builder

parseDelimitedFrom(InputStream input)

public static RoutingParameter parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RoutingParameter
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RoutingParameter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RoutingParameter
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RoutingParameter parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RoutingParameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RoutingParameter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RoutingParameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RoutingParameter parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RoutingParameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RoutingParameter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RoutingParameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RoutingParameter parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RoutingParameter
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RoutingParameter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RoutingParameter
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RoutingParameter parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RoutingParameter
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RoutingParameter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RoutingParameter
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RoutingParameter parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RoutingParameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RoutingParameter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RoutingParameter
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RoutingParameter> parser()
Returns
TypeDescription
Parser<RoutingParameter>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public RoutingParameter getDefaultInstanceForType()
Returns
TypeDescription
RoutingParameter

getField()

public String getField()

A request field to extract the header key-value pair from.

string field = 1;

Returns
TypeDescription
String

The field.

getFieldBytes()

public ByteString getFieldBytes()

A request field to extract the header key-value pair from.

string field = 1;

Returns
TypeDescription
ByteString

The bytes for field.

getParserForType()

public Parser<RoutingParameter> getParserForType()
Returns
TypeDescription
Parser<RoutingParameter>
Overrides

getPathTemplate()

public 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;

Returns
TypeDescription
String

The pathTemplate.

getPathTemplateBytes()

public 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;

Returns
TypeDescription
ByteString

The bytes for pathTemplate.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RoutingParameter.Builder newBuilderForType()
Returns
TypeDescription
RoutingParameter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RoutingParameter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RoutingParameter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RoutingParameter.Builder toBuilder()
Returns
TypeDescription
RoutingParameter.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException