Reference documentation and code samples for the Google Cloud Network Services V1 Client class GrpcRoute.
GrpcRoute is the resource defining how gRPC traffic routed by a Mesh or Gateway resource is routed.
Generated from protobuf message google.cloud.networkservices.v1.GrpcRoute
Namespace
Google \ Cloud \ NetworkServices \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Name of the GrpcRoute resource. It matches pattern |
↳ self_link |
string
Output only. Server-defined URL of this resource |
↳ create_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the resource was created. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The timestamp when the resource was updated. |
↳ labels |
array|Google\Protobuf\Internal\MapField
Optional. Set of label tags associated with the GrpcRoute resource. |
↳ description |
string
Optional. A free-text description of the resource. Max length 1024 characters. |
↳ hostnames |
array
Required. Service hostnames with an optional port for which this route describes traffic. Format:
|
↳ meshes |
array
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: |
↳ gateways |
array
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: |
↳ rules |
array<Google\Cloud\NetworkServices\V1\GrpcRoute\RouteRule>
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. |
getName
Required. Name of the GrpcRoute resource. It matches pattern
projects/*/locations/global/grpcRoutes/<grpc_route_name>
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. Name of the GrpcRoute resource. It matches pattern
projects/*/locations/global/grpcRoutes/<grpc_route_name>
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelfLink
Output only. Server-defined URL of this resource
| Returns | |
|---|---|
| Type | Description |
string |
|
setSelfLink
Output only. Server-defined URL of this resource
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. The timestamp when the resource was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when the resource was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The timestamp when the resource was updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when the resource was updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLabels
Optional. Set of label tags associated with the GrpcRoute resource.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setLabels
Optional. Set of label tags associated with the GrpcRoute resource.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. A free-text description of the resource. Max length 1024 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. A free-text description of the resource. Max length 1024 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHostnames
Required. Service hostnames with an optional port for which this route describes traffic.
Format:
- 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").
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setHostnames
Required. Service hostnames with an optional port for which this route describes traffic.
Format:
- 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").
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMeshes
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>
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setMeshes
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>
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGateways
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>
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setGateways
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>
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRules
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setRules
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\NetworkServices\V1\GrpcRoute\RouteRule>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|