Struct google_api_proto::google::cloud::networkservices::v1::GrpcRoute

pub struct GrpcRoute {
    pub name: String,
    pub self_link: String,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub labels: BTreeMap<String, String>,
    pub description: String,
    pub hostnames: Vec<String>,
    pub meshes: Vec<String>,
    pub gateways: Vec<String>,
    pub rules: Vec<RouteRule>,
}

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

Fields

name: String

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

self_link: String

Output only. Server-defined URL of this resource

create_time: Option<Timestamp>

Output only. The timestamp when the resource was created.

update_time: Option<Timestamp>

Output only. The timestamp when the resource was updated.

labels: BTreeMap<String, String>

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: Vec<String>

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: Vec<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/<mesh_name>

gateways: Vec<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/<gateway_name>

rules: Vec<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.

Trait Implementations

impl Clone for GrpcRoute

fn clone(&self) -> GrpcRoute

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GrpcRoute

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GrpcRoute

fn default() -> Self

Returns the “default value” for a type.

impl Message for GrpcRoute

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for GrpcRoute

fn eq(&self, other: &GrpcRoute) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GrpcRoute