public static final class GrpcRoute.Builder extends GeneratedMessageV3.Builder<GrpcRoute.Builder> implements GrpcRouteOrBuilderGrpcRoute is the resource defining how gRPC traffic routed by a Mesh or Gateway resource is routed.
Protobuf type google.events.cloud.networkservices.v1.GrpcRoute
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GrpcRoute.BuilderImplements
GrpcRouteOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllGateways(Iterable<String> values)
public GrpcRoute.Builder addAllGateways(Iterable<String> values) Optional. Gateways defines a list of gateways this GrpcRoute is attached
to, as one of the routing rules to route the requests served by the
gateway.
Each gateway reference should match the pattern:
projects/*/locations/global/gateways/<gateway_name>
repeated string gateways = 10;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The gateways to add. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
addAllHostnames(Iterable<String> values)
public GrpcRoute.Builder addAllHostnames(Iterable<String> values)Required. Service hostnames with an optional port for which this route describes traffic. Format: <hostname>[:<port>] Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
.). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g.foo.example.com) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g..example.com). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateway must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames.foo.bar.comand.bar.comto be associated with the same route, it is not possible to associate two routes both with*.bar.comor both withbar.com. If a port is specified, then gRPC clients must use the channel URI with the port to match this rule (i.e. "xds:///service:123"), otherwise they must supply the URI without a port (i.e. "xds:///service").
repeated string hostnames = 6;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The hostnames to add. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
addAllMeshes(Iterable<String> values)
public GrpcRoute.Builder addAllMeshes(Iterable<String> values) Optional. Meshes defines a list of meshes this GrpcRoute is attached to, as
one of the routing rules to route the requests served by the mesh.
Each mesh reference should match the pattern:
projects/*/locations/global/meshes/<mesh_name>
repeated string meshes = 9;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The meshes to add. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
addAllRules(Iterable<? extends GrpcRoute.RouteRule> values)
public GrpcRoute.Builder addAllRules(Iterable<? extends GrpcRoute.RouteRule> values)Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.events.cloud.networkservices.v1.GrpcRoute.RouteRule> |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
addGateways(String value)
public GrpcRoute.Builder addGateways(String value) Optional. Gateways defines a list of gateways this GrpcRoute is attached
to, as one of the routing rules to route the requests served by the
gateway.
Each gateway reference should match the pattern:
projects/*/locations/global/gateways/<gateway_name>
repeated string gateways = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe gateways to add. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
addGatewaysBytes(ByteString value)
public GrpcRoute.Builder addGatewaysBytes(ByteString value) Optional. Gateways defines a list of gateways this GrpcRoute is attached
to, as one of the routing rules to route the requests served by the
gateway.
Each gateway reference should match the pattern:
projects/*/locations/global/gateways/<gateway_name>
repeated string gateways = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the gateways to add. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
addHostnames(String value)
public GrpcRoute.Builder addHostnames(String value)Required. Service hostnames with an optional port for which this route describes traffic. Format: <hostname>[:<port>] Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
.). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g.foo.example.com) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g..example.com). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateway must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames.foo.bar.comand.bar.comto be associated with the same route, it is not possible to associate two routes both with*.bar.comor both withbar.com. If a port is specified, then gRPC clients must use the channel URI with the port to match this rule (i.e. "xds:///service:123"), otherwise they must supply the URI without a port (i.e. "xds:///service").
repeated string hostnames = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe hostnames to add. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
addHostnamesBytes(ByteString value)
public GrpcRoute.Builder addHostnamesBytes(ByteString value)Required. Service hostnames with an optional port for which this route describes traffic. Format: <hostname>[:<port>] Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
.). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g.foo.example.com) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g..example.com). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateway must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames.foo.bar.comand.bar.comto be associated with the same route, it is not possible to associate two routes both with*.bar.comor both withbar.com. If a port is specified, then gRPC clients must use the channel URI with the port to match this rule (i.e. "xds:///service:123"), otherwise they must supply the URI without a port (i.e. "xds:///service").
repeated string hostnames = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the hostnames to add. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
addMeshes(String value)
public GrpcRoute.Builder addMeshes(String value) Optional. Meshes defines a list of meshes this GrpcRoute is attached to, as
one of the routing rules to route the requests served by the mesh.
Each mesh reference should match the pattern:
projects/*/locations/global/meshes/<mesh_name>
repeated string meshes = 9;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe meshes to add. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
addMeshesBytes(ByteString value)
public GrpcRoute.Builder addMeshesBytes(ByteString value) Optional. Meshes defines a list of meshes this GrpcRoute is attached to, as
one of the routing rules to route the requests served by the mesh.
Each mesh reference should match the pattern:
projects/*/locations/global/meshes/<mesh_name>
repeated string meshes = 9;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the meshes to add. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GrpcRoute.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
addRules(GrpcRoute.RouteRule value)
public GrpcRoute.Builder addRules(GrpcRoute.RouteRule value)Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
GrpcRoute.RouteRule |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
addRules(GrpcRoute.RouteRule.Builder builderForValue)
public GrpcRoute.Builder addRules(GrpcRoute.RouteRule.Builder builderForValue)Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
GrpcRoute.RouteRule.Builder |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
addRules(int index, GrpcRoute.RouteRule value)
public GrpcRoute.Builder addRules(int index, GrpcRoute.RouteRule value)Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
GrpcRoute.RouteRule |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
addRules(int index, GrpcRoute.RouteRule.Builder builderForValue)
public GrpcRoute.Builder addRules(int index, GrpcRoute.RouteRule.Builder builderForValue)Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
GrpcRoute.RouteRule.Builder |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
addRulesBuilder()
public GrpcRoute.RouteRule.Builder addRulesBuilder()Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.RouteRule.Builder |
|
addRulesBuilder(int index)
public GrpcRoute.RouteRule.Builder addRulesBuilder(int index)Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.RouteRule.Builder |
|
build()
public GrpcRoute build()| Returns | |
|---|---|
| Type | Description |
GrpcRoute |
|
buildPartial()
public GrpcRoute buildPartial()| Returns | |
|---|---|
| Type | Description |
GrpcRoute |
|
clear()
public GrpcRoute.Builder clear()| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
clearCreateTime()
public GrpcRoute.Builder clearCreateTime()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2;
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
clearDescription()
public GrpcRoute.Builder clearDescription()Optional. A free-text description of the resource. Max length 1024 characters.
string description = 5;
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public GrpcRoute.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
clearGateways()
public GrpcRoute.Builder clearGateways() Optional. Gateways defines a list of gateways this GrpcRoute is attached
to, as one of the routing rules to route the requests served by the
gateway.
Each gateway reference should match the pattern:
projects/*/locations/global/gateways/<gateway_name>
repeated string gateways = 10;
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
clearHostnames()
public GrpcRoute.Builder clearHostnames()Required. Service hostnames with an optional port for which this route describes traffic. Format: <hostname>[:<port>] Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
.). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g.foo.example.com) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g..example.com). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateway must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames.foo.bar.comand.bar.comto be associated with the same route, it is not possible to associate two routes both with*.bar.comor both withbar.com. If a port is specified, then gRPC clients must use the channel URI with the port to match this rule (i.e. "xds:///service:123"), otherwise they must supply the URI without a port (i.e. "xds:///service").
repeated string hostnames = 6;
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
clearLabels()
public GrpcRoute.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
clearMeshes()
public GrpcRoute.Builder clearMeshes() Optional. Meshes defines a list of meshes this GrpcRoute is attached to, as
one of the routing rules to route the requests served by the mesh.
Each mesh reference should match the pattern:
projects/*/locations/global/meshes/<mesh_name>
repeated string meshes = 9;
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
clearName()
public GrpcRoute.Builder clearName() Required. Name of the GrpcRoute resource. It matches pattern
projects/*/locations/global/grpcRoutes/<grpc_route_name>
string name = 1;
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public GrpcRoute.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
clearRules()
public GrpcRoute.Builder clearRules()Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
clearSelfLink()
public GrpcRoute.Builder clearSelfLink()Output only. Server-defined URL of this resource
string self_link = 12;
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
clearUpdateTime()
public GrpcRoute.Builder clearUpdateTime()Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3;
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
clone()
public GrpcRoute.Builder clone()| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
containsLabels(String key)
public boolean containsLabels(String key)Optional. Set of label tags associated with the GrpcRoute resource.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getCreateTime()
public Timestamp getCreateTime()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public GrpcRoute getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
GrpcRoute |
|
getDescription()
public String getDescription()Optional. A free-text description of the resource. Max length 1024 characters.
string description = 5;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()Optional. A free-text description of the resource. Max length 1024 characters.
string description = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getGateways(int index)
public String getGateways(int index) Optional. Gateways defines a list of gateways this GrpcRoute is attached
to, as one of the routing rules to route the requests served by the
gateway.
Each gateway reference should match the pattern:
projects/*/locations/global/gateways/<gateway_name>
repeated string gateways = 10;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The gateways at the given index. |
getGatewaysBytes(int index)
public ByteString getGatewaysBytes(int index) Optional. Gateways defines a list of gateways this GrpcRoute is attached
to, as one of the routing rules to route the requests served by the
gateway.
Each gateway reference should match the pattern:
projects/*/locations/global/gateways/<gateway_name>
repeated string gateways = 10;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the gateways at the given index. |
getGatewaysCount()
public int getGatewaysCount() Optional. Gateways defines a list of gateways this GrpcRoute is attached
to, as one of the routing rules to route the requests served by the
gateway.
Each gateway reference should match the pattern:
projects/*/locations/global/gateways/<gateway_name>
repeated string gateways = 10;
| Returns | |
|---|---|
| Type | Description |
int |
The count of gateways. |
getGatewaysList()
public ProtocolStringList getGatewaysList() Optional. Gateways defines a list of gateways this GrpcRoute is attached
to, as one of the routing rules to route the requests served by the
gateway.
Each gateway reference should match the pattern:
projects/*/locations/global/gateways/<gateway_name>
repeated string gateways = 10;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the gateways. |
getHostnames(int index)
public String getHostnames(int index)Required. Service hostnames with an optional port for which this route describes traffic. Format: <hostname>[:<port>] Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
.). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g.foo.example.com) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g..example.com). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateway must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames.foo.bar.comand.bar.comto be associated with the same route, it is not possible to associate two routes both with*.bar.comor both withbar.com. If a port is specified, then gRPC clients must use the channel URI with the port to match this rule (i.e. "xds:///service:123"), otherwise they must supply the URI without a port (i.e. "xds:///service").
repeated string hostnames = 6;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The hostnames at the given index. |
getHostnamesBytes(int index)
public ByteString getHostnamesBytes(int index)Required. Service hostnames with an optional port for which this route describes traffic. Format: <hostname>[:<port>] Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
.). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g.foo.example.com) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g..example.com). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateway must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames.foo.bar.comand.bar.comto be associated with the same route, it is not possible to associate two routes both with*.bar.comor both withbar.com. If a port is specified, then gRPC clients must use the channel URI with the port to match this rule (i.e. "xds:///service:123"), otherwise they must supply the URI without a port (i.e. "xds:///service").
repeated string hostnames = 6;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the hostnames at the given index. |
getHostnamesCount()
public int getHostnamesCount()Required. Service hostnames with an optional port for which this route describes traffic. Format: <hostname>[:<port>] Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
.). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g.foo.example.com) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g..example.com). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateway must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames.foo.bar.comand.bar.comto be associated with the same route, it is not possible to associate two routes both with*.bar.comor both withbar.com. If a port is specified, then gRPC clients must use the channel URI with the port to match this rule (i.e. "xds:///service:123"), otherwise they must supply the URI without a port (i.e. "xds:///service").
repeated string hostnames = 6;
| Returns | |
|---|---|
| Type | Description |
int |
The count of hostnames. |
getHostnamesList()
public ProtocolStringList getHostnamesList()Required. Service hostnames with an optional port for which this route describes traffic. Format: <hostname>[:<port>] Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
.). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g.foo.example.com) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g..example.com). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateway must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames.foo.bar.comand.bar.comto be associated with the same route, it is not possible to associate two routes both with*.bar.comor both withbar.com. If a port is specified, then gRPC clients must use the channel URI with the port to match this rule (i.e. "xds:///service:123"), otherwise they must supply the URI without a port (i.e. "xds:///service").
repeated string hostnames = 6;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the hostnames. |
getLabels()
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public int getLabelsCount()Optional. Set of label tags associated with the GrpcRoute resource.
map<string, string> labels = 4;
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()Optional. Set of label tags associated with the GrpcRoute resource.
map<string, string> labels = 4;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)Optional. Set of label tags associated with the GrpcRoute resource.
map<string, string> labels = 4;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)Optional. Set of label tags associated with the GrpcRoute resource.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getMeshes(int index)
public String getMeshes(int index) Optional. Meshes defines a list of meshes this GrpcRoute is attached to, as
one of the routing rules to route the requests served by the mesh.
Each mesh reference should match the pattern:
projects/*/locations/global/meshes/<mesh_name>
repeated string meshes = 9;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The meshes at the given index. |
getMeshesBytes(int index)
public ByteString getMeshesBytes(int index) Optional. Meshes defines a list of meshes this GrpcRoute is attached to, as
one of the routing rules to route the requests served by the mesh.
Each mesh reference should match the pattern:
projects/*/locations/global/meshes/<mesh_name>
repeated string meshes = 9;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the meshes at the given index. |
getMeshesCount()
public int getMeshesCount() Optional. Meshes defines a list of meshes this GrpcRoute is attached to, as
one of the routing rules to route the requests served by the mesh.
Each mesh reference should match the pattern:
projects/*/locations/global/meshes/<mesh_name>
repeated string meshes = 9;
| Returns | |
|---|---|
| Type | Description |
int |
The count of meshes. |
getMeshesList()
public ProtocolStringList getMeshesList() Optional. Meshes defines a list of meshes this GrpcRoute is attached to, as
one of the routing rules to route the requests served by the mesh.
Each mesh reference should match the pattern:
projects/*/locations/global/meshes/<mesh_name>
repeated string meshes = 9;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the meshes. |
getMutableLabels()
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getName()
public String getName() Required. Name of the GrpcRoute resource. It matches pattern
projects/*/locations/global/grpcRoutes/<grpc_route_name>
string name = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes() Required. Name of the GrpcRoute resource. It matches pattern
projects/*/locations/global/grpcRoutes/<grpc_route_name>
string name = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getRules(int index)
public GrpcRoute.RouteRule getRules(int index)Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.RouteRule |
|
getRulesBuilder(int index)
public GrpcRoute.RouteRule.Builder getRulesBuilder(int index)Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.RouteRule.Builder |
|
getRulesBuilderList()
public List<GrpcRoute.RouteRule.Builder> getRulesBuilderList()Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getRulesCount()
public int getRulesCount()Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Returns | |
|---|---|
| Type | Description |
int |
|
getRulesList()
public List<GrpcRoute.RouteRule> getRulesList()Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Returns | |
|---|---|
| Type | Description |
List<RouteRule> |
|
getRulesOrBuilder(int index)
public GrpcRoute.RouteRuleOrBuilder getRulesOrBuilder(int index)Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.RouteRuleOrBuilder |
|
getRulesOrBuilderList()
public List<? extends GrpcRoute.RouteRuleOrBuilder> getRulesOrBuilderList()Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.events.cloud.networkservices.v1.GrpcRoute.RouteRuleOrBuilder> |
|
getSelfLink()
public String getSelfLink()Output only. Server-defined URL of this resource
string self_link = 12;
| Returns | |
|---|---|
| Type | Description |
String |
The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()Output only. Server-defined URL of this resource
string self_link = 12;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for selfLink. |
getUpdateTime()
public Timestamp getUpdateTime()Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasCreateTime()
public boolean hasCreateTime()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasUpdateTime()
public boolean hasUpdateTime()Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
MapField |
|
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
MapField |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCreateTime(Timestamp value)
public GrpcRoute.Builder mergeCreateTime(Timestamp value)Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
mergeFrom(GrpcRoute other)
public GrpcRoute.Builder mergeFrom(GrpcRoute other)| Parameter | |
|---|---|
| Name | Description |
other |
GrpcRoute |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GrpcRoute.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public GrpcRoute.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GrpcRoute.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
mergeUpdateTime(Timestamp value)
public GrpcRoute.Builder mergeUpdateTime(Timestamp value)Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
putAllLabels(Map<String,String> values)
public GrpcRoute.Builder putAllLabels(Map<String,String> values)Optional. Set of label tags associated with the GrpcRoute resource.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
putLabels(String key, String value)
public GrpcRoute.Builder putLabels(String key, String value)Optional. Set of label tags associated with the GrpcRoute resource.
map<string, string> labels = 4;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
removeLabels(String key)
public GrpcRoute.Builder removeLabels(String key)Optional. Set of label tags associated with the GrpcRoute resource.
map<string, string> labels = 4;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
removeRules(int index)
public GrpcRoute.Builder removeRules(int index)Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
setCreateTime(Timestamp value)
public GrpcRoute.Builder setCreateTime(Timestamp value)Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public GrpcRoute.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
setDescription(String value)
public GrpcRoute.Builder setDescription(String value)Optional. A free-text description of the resource. Max length 1024 characters.
string description = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public GrpcRoute.Builder setDescriptionBytes(ByteString value)Optional. A free-text description of the resource. Max length 1024 characters.
string description = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public GrpcRoute.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
setGateways(int index, String value)
public GrpcRoute.Builder setGateways(int index, String value) Optional. Gateways defines a list of gateways this GrpcRoute is attached
to, as one of the routing rules to route the requests served by the
gateway.
Each gateway reference should match the pattern:
projects/*/locations/global/gateways/<gateway_name>
repeated string gateways = 10;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe gateways to set. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
setHostnames(int index, String value)
public GrpcRoute.Builder setHostnames(int index, String value)Required. Service hostnames with an optional port for which this route describes traffic. Format: <hostname>[:<port>] Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions:
- IPs are not allowed.
- A hostname may be prefixed with a wildcard label (
.). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g.foo.example.com) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g..example.com). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateway must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames.foo.bar.comand.bar.comto be associated with the same route, it is not possible to associate two routes both with*.bar.comor both withbar.com. If a port is specified, then gRPC clients must use the channel URI with the port to match this rule (i.e. "xds:///service:123"), otherwise they must supply the URI without a port (i.e. "xds:///service").
repeated string hostnames = 6;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe hostnames to set. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
setMeshes(int index, String value)
public GrpcRoute.Builder setMeshes(int index, String value) Optional. Meshes defines a list of meshes this GrpcRoute is attached to, as
one of the routing rules to route the requests served by the mesh.
Each mesh reference should match the pattern:
projects/*/locations/global/meshes/<mesh_name>
repeated string meshes = 9;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe meshes to set. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
setName(String value)
public GrpcRoute.Builder setName(String value) Required. Name of the GrpcRoute resource. It matches pattern
projects/*/locations/global/grpcRoutes/<grpc_route_name>
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public GrpcRoute.Builder setNameBytes(ByteString value) Required. Name of the GrpcRoute resource. It matches pattern
projects/*/locations/global/grpcRoutes/<grpc_route_name>
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public GrpcRoute.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
setRules(int index, GrpcRoute.RouteRule value)
public GrpcRoute.Builder setRules(int index, GrpcRoute.RouteRule value)Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
GrpcRoute.RouteRule |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
setRules(int index, GrpcRoute.RouteRule.Builder builderForValue)
public GrpcRoute.Builder setRules(int index, GrpcRoute.RouteRule.Builder builderForValue)Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied.
repeated .google.events.cloud.networkservices.v1.GrpcRoute.RouteRule rules = 7;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
GrpcRoute.RouteRule.Builder |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
setSelfLink(String value)
public GrpcRoute.Builder setSelfLink(String value)Output only. Server-defined URL of this resource
string self_link = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe selfLink to set. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
setSelfLinkBytes(ByteString value)
public GrpcRoute.Builder setSelfLinkBytes(ByteString value)Output only. Server-defined URL of this resource
string self_link = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for selfLink to set. |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final GrpcRoute.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
setUpdateTime(Timestamp value)
public GrpcRoute.Builder setUpdateTime(Timestamp value)Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public GrpcRoute.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
GrpcRoute.Builder |
|