Interface GrpcRouteOrBuilder (0.16.0)

public interface GrpcRouteOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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 abstract Timestamp getCreateTime()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type	Description
`TimestampOrBuilder`

getDescription()

public abstract 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 abstract 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.

getGateways(int index)

public abstract 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`	`int` The index of the element to return.

Returns
Type	Description
`String`	The gateways at the given index.

getGatewaysBytes(int index)

public abstract ByteString getGatewaysBytes(int index)

repeated string gateways = 10;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the gateways at the given index.

getGatewaysCount()

public abstract int getGatewaysCount()

repeated string gateways = 10;

Returns
Type	Description
`int`	The count of gateways.

getGatewaysList()

public abstract List<String> getGatewaysList()

repeated string gateways = 10;

Returns
Type	Description
`List<String>`	A list containing the gateways.

getHostnames(int index)

public abstract 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.com and .bar.com to be associated with the same route, it is not possible to associate two routes both with *.bar.com or both with bar.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`	`int` The index of the element to return.

Returns
Type	Description
`String`	The hostnames at the given index.

getHostnamesBytes(int index)

public abstract ByteString getHostnamesBytes(int index)

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.com and .bar.com to be associated with the same route, it is not possible to associate two routes both with *.bar.com or both with bar.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`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the hostnames at the given index.

getHostnamesCount()

public abstract int getHostnamesCount()

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.com and .bar.com to be associated with the same route, it is not possible to associate two routes both with *.bar.com or both with bar.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 abstract List<String> getHostnamesList()

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.com and .bar.com to be associated with the same route, it is not possible to associate two routes both with *.bar.com or both with bar.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
`List<String>`	A list containing the hostnames.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public abstract int getLabelsCount()

Optional. Set of label tags associated with the GrpcRoute resource.

map<string, string> labels = 4;

Returns
Type	Description
`int`

getLabelsMap()

public abstract 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 abstract 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 abstract 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 abstract 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`	`int` The index of the element to return.

Returns
Type	Description
`String`	The meshes at the given index.

getMeshesBytes(int index)

public abstract ByteString getMeshesBytes(int index)

repeated string meshes = 9;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the meshes at the given index.

getMeshesCount()

public abstract int getMeshesCount()

repeated string meshes = 9;

Returns
Type	Description
`int`	The count of meshes.

getMeshesList()

public abstract List<String> getMeshesList()

repeated string meshes = 9;

Returns
Type	Description
`List<String>`	A list containing the meshes.

getName()

public abstract 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 abstract 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 abstract 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.