GrpcRouteArgs class

The set of arguments for GrpcRoute. The set of arguments for GrpcRoute.

Constructors

GrpcRouteArgs({Input<String>? description, Input<List<String>>? gateways, required Input<String> grpcRouteId, required Input<List<String>> hostnames, Input<Map<String, String>>? labels, Input<String>? location, Input<List<String>>? meshes, Input<String>? name, Input<String>? project, required Input<List<GrpcRouteRouteRule>> rules})
Creates a new GrpcRouteArgs. description Optional. A free-text description of the resource. Max length 1024 characters. gateways 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/ grpcRouteId Required. Short name of the GrpcRoute resource to be created. hostnames Service hostnames with an optional port for which this route describes traffic. Format: : 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"). labels Optional. Set of label tags associated with the GrpcRoute resource. location Optional. meshes 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/ name Name of the GrpcRoute resource. It matches pattern projects/*/locations/global/grpcRoutes/ project Optional. rules 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.
const
GrpcRouteArgs.fromMap(Map<String, dynamic> map)
factory

Properties

description → Input<String>?
Optional. A free-text description of the resource. Max length 1024 characters.
final
gateways → Input<List<String>>?
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/
final
grpcRouteId → Input<String>
Required. Short name of the GrpcRoute resource to be created.
final
hashCode → int
The hash code for this object.
no setterinherited
hostnames → Input<List<String>>
Service hostnames with an optional port for which this route describes traffic. Format: : 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").
final
labels → Input<Map<String, String>>?
Optional. Set of label tags associated with the GrpcRoute resource.
final
location → Input<String>?
final
meshes → Input<List<String>>?
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/
final
name → Input<String>?
Name of the GrpcRoute resource. It matches pattern projects/*/locations/global/grpcRoutes/
final
project → Input<String>?
final
rules → Input<List<GrpcRouteRouteRule>>
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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited