Network Services V1 API - Class Google::Cloud::NetworkServices::V1::HttpRoute (v1.0.1)

Reference documentation and code samples for the Network Services V1 API class Google::Cloud::NetworkServices::V1::HttpRoute.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. A free-text description of the resource. Max length 1024 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. A free-text description of the resource. Max length 1024 characters.
Returns
  • (::String) — Optional. A free-text description of the resource. Max length 1024 characters.

#gateways

def gateways() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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>

#gateways=

def gateways=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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>

Returns
  • (::Array<::String>) — 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>

#hostnames

def hostnames() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#hostnames=

def hostnames=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.

Returns
  • (::Array<::String>) — 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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of label tags associated with the HttpRoute resource.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of label tags associated with the HttpRoute resource.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Optional. Set of label tags associated with the HttpRoute resource.

#meshes

def meshes() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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

#meshes=

def meshes=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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

Returns
  • (::Array<::String>) — 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

#name

def name() -> ::String
Returns
  • (::String) — Required. Name of the HttpRoute resource. It matches pattern projects/*/locations/global/httpRoutes/http_route_name>.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. Name of the HttpRoute resource. It matches pattern projects/*/locations/global/httpRoutes/http_route_name>.
Returns
  • (::String) — Required. Name of the HttpRoute resource. It matches pattern projects/*/locations/global/httpRoutes/http_route_name>.

#rules

def rules() -> ::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteRule>
Returns

#rules=

def rules=(value) -> ::Array<::Google::Cloud::NetworkServices::V1::HttpRoute::RouteRule>
Parameter
Returns

#self_link

def self_link() -> ::String
Returns
  • (::String) — Output only. Server-defined URL of this resource

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns