Network Services v1 API - Class GrpcRoute (1.0.0-beta01)

public sealed class GrpcRoute : IMessage<GrpcRoute>, IEquatable<GrpcRoute>, IDeepCloneable<GrpcRoute>, IBufferMessage, IMessage

Reference documentation and code samples for the Network Services v1 API class GrpcRoute.

GrpcRoute is the resource defining how gRPC traffic routed by a Mesh or Gateway resource is routed.

Inheritance

object > GrpcRoute

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

GrpcRoute()

public GrpcRoute()

GrpcRoute(GrpcRoute)

public GrpcRoute(GrpcRoute other)
Parameter
Name Description
other GrpcRoute

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. The timestamp when the resource was created.

Property Value
Type Description
Timestamp

Description

public string Description { get; set; }

Optional. A free-text description of the resource. Max length 1024 characters.

Property Value
Type Description
string

Gateways

public RepeatedField<string> Gateways { get; }

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>

Property Value
Type Description
RepeatedFieldstring

GatewaysAsGatewayNames

public ResourceNameList<GatewayName> GatewaysAsGatewayNames { get; }

GatewayName-typed view over the Gateways resource name property.

Property Value
Type Description
ResourceNameListGatewayName

GrpcRouteName

public GrpcRouteName GrpcRouteName { get; set; }

GrpcRouteName-typed view over the Name resource name property.

Property Value
Type Description
GrpcRouteName

Hostnames

public RepeatedField<string> Hostnames { get; }

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").

Property Value
Type Description
RepeatedFieldstring

Labels

public MapField<string, string> Labels { get; }

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

Property Value
Type Description
MapFieldstringstring

Meshes

public RepeatedField<string> Meshes { get; }

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>

Property Value
Type Description
RepeatedFieldstring

MeshesAsMeshNames

public ResourceNameList<MeshName> MeshesAsMeshNames { get; }

MeshName-typed view over the Meshes resource name property.

Property Value
Type Description
ResourceNameListMeshName

Name

public string Name { get; set; }

Required. Name of the GrpcRoute resource. It matches pattern projects/*/locations/global/grpcRoutes/<grpc_route_name>

Property Value
Type Description
string

Rules

public RepeatedField<GrpcRoute.Types.RouteRule> Rules { get; }

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.

Property Value
Type Description
RepeatedFieldGrpcRouteTypesRouteRule 
public string SelfLink { get; set; }

Output only. Server-defined URL of this resource

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. The timestamp when the resource was updated.

Property Value
Type Description
Timestamp