public static final class RoutingRule.Builder extends GeneratedMessageV3.Builder<RoutingRule.Builder> implements RoutingRuleOrBuilderSpecifies the routing information that should be sent along with the request in the form of routing header. NOTE: All service configuration rules follow the "last one wins" order.
The examples below will apply to an RPC which has the following request type:
Message Definition:
message Request {
// The name of the Table
// Values can be of the following formats:
// - <code>projects/<project>/tables/<table></code>
// - <code>projects/<project>/instances/<instance>/tables/<table></code>
// - <code>region/<region>/zones/<zone>/tables/<table></code>
string table_name = 1;
// This value specifies routing for replication.
// It can be in the following formats:
// - <code>profiles/<profile_id></code>
// - a legacy <code>profile_id</code> that can be any string
string app_profile_id = 2;
}
Example message:
{
table_name: projects/proj_foo/instances/instance_bar/table/table_baz,
app_profile_id: profiles/prof_qux
}
The routing header consists of one or multiple key-value pairs. Every key
and value must be percent-encoded, and joined together in the format of
key1=value1&key2=value2.
In the examples below I am skipping the percent-encoding for readablity.
Example 1
Extracting a field from the request to put into the routing header unchanged, with the key equal to the field name.
annotation:
option (google.api.routing) = {
// Take the <code>app_profile_id</code>.
routing_parameters {
field: "app_profile_id"
}
};
result:
x-goog-request-params: app_profile_id=profiles/prof_qux
Example 2
Extracting a field from the request to put into the routing header unchanged, with the key different from the field name.
annotation:
option (google.api.routing) = {
// Take the <code>app_profile_id</code>, but name it <code>routing_id</code> in the header.
routing_parameters {
field: "app_profile_id"
path_template: "{routing_id=**}"
}
};
result:
x-goog-request-params: routing_id=profiles/prof_qux
Example 3
Extracting a field from the request to put into the routing header, while matching a path template syntax on the field's value.
NB: it is more useful to send nothing than to send garbage for the purpose of dynamic routing, since garbage pollutes cache. Thus the matching.
Sub-example 3a
The field matches the template.
annotation:
option (google.api.routing) = {
// Take the <code>table_name</code>, if it's well-formed (with project-based
// syntax).
routing_parameters {
field: "table_name"
path_template: "{table_name=projects/*/instances/*/**}"
}
};
result:
x-goog-request-params:
table_name=projects/proj_foo/instances/instance_bar/table/table_baz
Sub-example 3b
The field does not match the template.
annotation:
option (google.api.routing) = {
// Take the <code>table_name</code>, if it's well-formed (with region-based
// syntax).
routing_parameters {
field: "table_name"
path_template: "{table_name=regions/*/zones/*/**}"
}
};
result:
<no routing header will be sent>
Sub-example 3c
Multiple alternative conflictingly named path templates are specified. The one that matches is used to construct the header.
annotation:
option (google.api.routing) = {
// Take the <code>table_name</code>, if it's well-formed, whether
// using the region- or projects-based syntax.
routing_parameters {
field: "table_name"
path_template: "{table_name=regions/*/zones/*/**}"
}
routing_parameters {
field: "table_name"
path_template: "{table_name=projects/*/instances/*/**}"
}
};
result:
x-goog-request-params:
table_name=projects/proj_foo/instances/instance_bar/table/table_baz
Example 4
Extracting a single routing header key-value pair by matching a template syntax on (a part of) a single request field.
annotation:
option (google.api.routing) = {
// Take just the project id from the <code>table_name</code> field.
routing_parameters {
field: "table_name"
path_template: "{routing_id=projects/*}/**"
}
};
result:
x-goog-request-params: routing_id=projects/proj_foo
Example 5
Extracting a single routing header key-value pair by matching several conflictingly named path templates on (parts of) a single request field. The last template to match "wins" the conflict.
annotation:
option (google.api.routing) = {
// If the <code>table_name</code> does not have instances information,
// take just the project id for routing.
// Otherwise take project + instance.
routing_parameters {
field: "table_name"
path_template: "{routing_id=projects/*}/**"
}
routing_parameters {
field: "table_name"
path_template: "{routing_id=projects/*/instances/*}/**"
}
};
result:
x-goog-request-params:
routing_id=projects/proj_foo/instances/instance_bar
Example 6
Extracting multiple routing header key-value pairs by matching several non-conflicting path templates on (parts of) a single request field.
Sub-example 6a
Make the templates strict, so that if the table_name does not
have an instance information, nothing is sent.
annotation:
option (google.api.routing) = {
// The routing code needs two keys instead of one composite
// but works only for the tables with the "project-instance" name
// syntax.
routing_parameters {
field: "table_name"
path_template: "{project_id=projects/*}/instances/*/**"
}
routing_parameters {
field: "table_name"
path_template: "projects/*/{instance_id=instances/*}/**"
}
};
result:
x-goog-request-params:
project_id=projects/proj_foo&instance_id=instances/instance_bar
Sub-example 6b
Make the templates loose, so that if the table_name does not
have an instance information, just the project id part is sent.
annotation:
option (google.api.routing) = {
// The routing code wants two keys instead of one composite
// but will work with just the <code>project_id</code> for tables without
// an instance in the <code>table_name</code>.
routing_parameters {
field: "table_name"
path_template: "{project_id=projects/*}/**"
}
routing_parameters {
field: "table_name"
path_template: "projects/*/{instance_id=instances/*}/**"
}
};
result (is the same as 6a for our example message because it has the instance information):
x-goog-request-params:
project_id=projects/proj_foo&instance_id=instances/instance_bar
Example 7
Extracting multiple routing header key-value pairs by matching several path templates on multiple request fields.
NB: note that here there is no way to specify sending nothing if one of the
fields does not match its template. E.g. if the table_name is in the wrong
format, the project_id will not be sent, but the routing_id will be.
The backend routing code has to be aware of that and be prepared to not
receive a full complement of keys if it expects multiple.
annotation:
option (google.api.routing) = {
// The routing needs both <code>project_id</code> and <code>routing_id</code>
// (from the <code>app_profile_id</code> field) for routing.
routing_parameters {
field: "table_name"
path_template: "{project_id=projects/*}/**"
}
routing_parameters {
field: "app_profile_id"
path_template: "{routing_id=**}"
}
};
result:
x-goog-request-params:
project_id=projects/proj_foo&routing_id=profiles/prof_qux
Example 8
Extracting a single routing header key-value pair by matching several conflictingly named path templates on several request fields. The last template to match "wins" the conflict.
annotation:
option (google.api.routing) = {
// The <code>routing_id</code> can be a project id or a region id depending on
// the table name format, but only if the <code>app_profile_id</code> is not set.
// If <code>app_profile_id</code> is set it should be used instead.
routing_parameters {
field: "table_name"
path_template: "{routing_id=projects/*}/**"
}
routing_parameters {
field: "table_name"
path_template: "{routing_id=regions/*}/**"
}
routing_parameters {
field: "app_profile_id"
path_template: "{routing_id=**}"
}
};
result:
x-goog-request-params: routing_id=profiles/prof_qux
Example 9
Bringing it all together.
annotation:
option (google.api.routing) = {
// For routing both <code>table_location</code> and a <code>routing_id</code> are needed.
//
// table_location can be either an instance id or a region+zone id.
//
// For <code>routing_id</code>, take the value of <code>app_profile_id</code>
// - If it's in the format <code>profiles/<profile_id></code>, send
// just the <code><profile_id></code> part.
// - If it's any other literal, send it as is.
// If the <code>app_profile_id</code> is empty, and the <code>table_name</code> starts with
// the project_id, send that instead.
routing_parameters {
field: "table_name"
path_template: "projects/*/{table_location=instances/*}/tables/*"
}
routing_parameters {
field: "table_name"
path_template: "{table_location=regions/*/zones/*}/tables/*"
}
routing_parameters {
field: "table_name"
path_template: "{routing_id=projects/*}/**"
}
routing_parameters {
field: "app_profile_id"
path_template: "{routing_id=**}"
}
routing_parameters {
field: "app_profile_id"
path_template: "profiles/{routing_id=*}"
}
};
result:
x-goog-request-params:
table_location=instances/instance_bar&routing_id=prof_qux
Protobuf type google.api.RoutingRule
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RoutingRule.BuilderImplements
RoutingRuleOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllRoutingParameters(Iterable<? extends RoutingParameter> values)
public RoutingRule.Builder addAllRoutingParameters(Iterable<? extends RoutingParameter> values) A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.api.RoutingParameter> |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public RoutingRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
addRoutingParameters(RoutingParameter value)
public RoutingRule.Builder addRoutingParameters(RoutingParameter value) A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
RoutingParameter |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
addRoutingParameters(RoutingParameter.Builder builderForValue)
public RoutingRule.Builder addRoutingParameters(RoutingParameter.Builder builderForValue) A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
RoutingParameter.Builder |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
addRoutingParameters(int index, RoutingParameter value)
public RoutingRule.Builder addRoutingParameters(int index, RoutingParameter value) A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
RoutingParameter |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
addRoutingParameters(int index, RoutingParameter.Builder builderForValue)
public RoutingRule.Builder addRoutingParameters(int index, RoutingParameter.Builder builderForValue) A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
RoutingParameter.Builder |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
addRoutingParametersBuilder()
public RoutingParameter.Builder addRoutingParametersBuilder() A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Returns | |
|---|---|
| Type | Description |
RoutingParameter.Builder |
|
addRoutingParametersBuilder(int index)
public RoutingParameter.Builder addRoutingParametersBuilder(int index) A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
RoutingParameter.Builder |
|
build()
public RoutingRule build()| Returns | |
|---|---|
| Type | Description |
RoutingRule |
|
buildPartial()
public RoutingRule buildPartial()| Returns | |
|---|---|
| Type | Description |
RoutingRule |
|
clear()
public RoutingRule.Builder clear()| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public RoutingRule.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public RoutingRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
clearRoutingParameters()
public RoutingRule.Builder clearRoutingParameters() A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
clone()
public RoutingRule.Builder clone()| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
getDefaultInstanceForType()
public RoutingRule getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
RoutingRule |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getRoutingParameters(int index)
public RoutingParameter getRoutingParameters(int index) A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
RoutingParameter |
|
getRoutingParametersBuilder(int index)
public RoutingParameter.Builder getRoutingParametersBuilder(int index) A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
RoutingParameter.Builder |
|
getRoutingParametersBuilderList()
public List<RoutingParameter.Builder> getRoutingParametersBuilderList() A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getRoutingParametersCount()
public int getRoutingParametersCount() A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Returns | |
|---|---|
| Type | Description |
int |
|
getRoutingParametersList()
public List<RoutingParameter> getRoutingParametersList() A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Returns | |
|---|---|
| Type | Description |
List<RoutingParameter> |
|
getRoutingParametersOrBuilder(int index)
public RoutingParameterOrBuilder getRoutingParametersOrBuilder(int index) A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
RoutingParameterOrBuilder |
|
getRoutingParametersOrBuilderList()
public List<? extends RoutingParameterOrBuilder> getRoutingParametersOrBuilderList() A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.api.RoutingParameterOrBuilder> |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(RoutingRule other)
public RoutingRule.Builder mergeFrom(RoutingRule other)| Parameter | |
|---|---|
| Name | Description |
other |
RoutingRule |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RoutingRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public RoutingRule.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final RoutingRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
removeRoutingParameters(int index)
public RoutingRule.Builder removeRoutingParameters(int index) A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public RoutingRule.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public RoutingRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
setRoutingParameters(int index, RoutingParameter value)
public RoutingRule.Builder setRoutingParameters(int index, RoutingParameter value) A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
RoutingParameter |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
setRoutingParameters(int index, RoutingParameter.Builder builderForValue)
public RoutingRule.Builder setRoutingParameters(int index, RoutingParameter.Builder builderForValue) A collection of Routing Parameter specifications.
NOTE: If multiple Routing Parameters describe the same key
(via the path_template field or via the field field when
path_template is not provided), "last one wins" rule
determines which Parameter gets used.
See the examples for more details.
repeated .google.api.RoutingParameter routing_parameters = 2;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
RoutingParameter.Builder |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final RoutingRule.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
RoutingRule.Builder |
|