public final class GrpcRoute extends GeneratedMessageV3 implements GrpcRouteOrBuilder
GrpcRoute is the resource defining how gRPC traffic routed by a Mesh
or Gateway resource is routed.
Protobuf type google.events.cloud.networkservices.v1.GrpcRoute
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
GATEWAYS_FIELD_NUMBER
public static final int GATEWAYS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
HOSTNAMES_FIELD_NUMBER
public static final int HOSTNAMES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MESHES_FIELD_NUMBER
public static final int MESHES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static GrpcRoute getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static GrpcRoute.Builder newBuilder()
newBuilder(GrpcRoute prototype)
public static GrpcRoute.Builder newBuilder(GrpcRoute prototype)
public static GrpcRoute parseDelimitedFrom(InputStream input)
public static GrpcRoute parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static GrpcRoute parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GrpcRoute parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static GrpcRoute parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GrpcRoute parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GrpcRoute parseFrom(CodedInputStream input)
public static GrpcRoute parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GrpcRoute parseFrom(InputStream input)
public static GrpcRoute parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static GrpcRoute parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GrpcRoute parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<GrpcRoute> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2;
getDefaultInstanceForType()
public GrpcRoute getDefaultInstanceForType()
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.
|
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 | int
The 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 | int
The 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;
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.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 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.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 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.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 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.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;
getLabels()
public Map<String,String> getLabels()
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;
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;
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
|
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 | int
The 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 | int
The 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;
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.
|
getParserForType()
public Parser<GrpcRoute> getParserForType()
Overrides
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
|
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;
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
|
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3;
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public GrpcRoute.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GrpcRoute.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public GrpcRoute.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
