Class GrpcRoute (0.2.1)

GrpcRoute(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes

Name	Description
name	`str` Required. Name of the GrpcRoute resource. It matches pattern ``projects/*/locations/global/grpcRoutes/
self_link	`str` Output only. Server-defined URL of this resource
create_time	`google.protobuf.timestamp_pb2.Timestamp` Output only. The timestamp when the resource was created.
update_time	`google.protobuf.timestamp_pb2.Timestamp` Output only. The timestamp when the resource was updated.
labels	`Mapping[str, str]` Optional. Set of label tags associated with the GrpcRoute resource.
description	`str` Optional. A free-text description of the resource. Max length 1024 characters.
hostnames	`Sequence[str]` Required. 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").
meshes	`Sequence[str]` 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/
gateways	`Sequence[str]` 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/
rules	`Sequence[google.cloud.network_services_v1.types.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.

Inheritance

builtins.object > proto.message.Message > GrpcRoute

Classes

Destination

Destination(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The destination to which traffic will be routed.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

FaultInjectionPolicy

FaultInjectionPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The specification for fault injection introduced into traffic to test the resiliency of clients to destination service failure. As part of fault injection, when clients send requests to a destination, delays can be introduced on a percentage of requests before sending those requests to the destination service. Similarly requests from clients can be aborted by for a percentage of requests.

HeaderMatch

HeaderMatch(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A match against a collection of headers.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters

Name	Description
kwargs	`dict` Keys and values corresponding to the fields of the message.
mapping	Union[dict, `.Message`] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

MethodMatch

MethodMatch(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Specifies a match against a method.

RetryPolicy

RetryPolicy(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The specifications for retries.

RouteAction

RouteAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Specifies how to route matched traffic.

RouteMatch

RouteMatch(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Criteria for matching traffic. A RouteMatch will be considered to match when all supplied fields match.

RouteRule

RouteRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Describes how to route traffic.