com.google.api

Interface RoutingParameterOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

RoutingParameter, RoutingParameter.Builder

public interface RoutingParameterOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
String	getPathTemplate() A pattern matching the key-value field.
com.google.protobuf.ByteString	getPathTemplateBytes() A pattern matching the key-value field.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getField

String getField()

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

string field = 1;

Returns:

The field.

getFieldBytes

com.google.protobuf.ByteString getFieldBytes()

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

string field = 1;

Returns:

The bytes for field.

getPathTemplate

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:

The pathTemplate.

getPathTemplateBytes

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;

Returns:

The bytes for pathTemplate.