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

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

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

HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource.

Inheritance

object > HttpRoute

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

HttpRoute()

public HttpRoute()

HttpRoute(HttpRoute)

public HttpRoute(HttpRoute other)
Parameter
Name Description
other HttpRoute

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 HttpRoute 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

Hostnames

public RepeatedField<string> Hostnames { get; }

Required. Hostnames define a set of hosts that should match against the HTTP host header to select a HttpRoute to process the request. Hostname is the fully qualified domain name of a network host, as defined by RFC 1123 with the exception that:

  • 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 Gateways 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 Mesh (or Gateways under the same scope), it is not possible to associate two routes both with *.bar.com or both with bar.com.

Property Value
Type Description
RepeatedFieldstring

HttpRouteName

public HttpRouteName HttpRouteName { get; set; }

HttpRouteName-typed view over the Name resource name property.

Property Value
Type Description
HttpRouteName

Labels

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

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

Property Value
Type Description
MapFieldstringstring

Meshes

public RepeatedField<string> Meshes { get; }

Optional. Meshes defines a list of meshes this HttpRoute 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>

The attached Mesh should be of a type SIDECAR

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 HttpRoute resource. It matches pattern projects/*/locations/global/httpRoutes/http_route_name>.

Property Value
Type Description
string

Rules

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

Required. Rules that define how traffic is routed and handled. Rules will be matched sequentially based on the RouteMatch specified for the rule.

Property Value
Type Description
RepeatedFieldHttpRouteTypesRouteRule 
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