Reference documentation and code samples for the Google Cloud Network Services V1 Client class HttpRoute.
HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource.
Generated from protobuf message google.cloud.networkservices.v1.HttpRoute
Namespace
Google \ Cloud \ NetworkServices \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. Name of the HttpRoute resource. It matches pattern projects/*/locations/global/httpRoutes/http_route_name>
.
↳ self_link
string
Output only. Server-defined URL of this resource
↳ description
string
Optional. A free-text description of the resource. Max length 1024 characters.
↳ create_time
↳ update_time
↳ hostnames
array
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
.
↳ meshes
array
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
↳ gateways
array
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>
↳ labels
array| Google\Protobuf\Internal\MapField
Optional. Set of label tags associated with the HttpRoute resource.
↳ rules
array< HttpRoute\RouteRule
>
Required. Rules that define how traffic is routed and handled. Rules will be matched sequentially based on the RouteMatch specified for the rule.
getName
Identifier. Name of the HttpRoute resource. It matches pattern projects/*/locations/global/httpRoutes/http_route_name>
.
string
setName
Identifier. Name of the HttpRoute resource. It matches pattern projects/*/locations/global/httpRoutes/http_route_name>
.
var
string
$this
getSelfLink
Output only. Server-defined URL of this resource
string
setSelfLink
Output only. Server-defined URL of this resource
var
string
$this
getDescription
Optional. A free-text description of the resource. Max length 1024 characters.
string
setDescription
Optional. A free-text description of the resource. Max length 1024 characters.
var
string
$this
getCreateTime
Output only. The timestamp when the resource was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The timestamp when the resource was created.
$this
getUpdateTime
Output only. The timestamp when the resource was updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp when the resource was updated.
$this
getHostnames
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.comand*.bar.comto be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with*.bar.comor both withbar.com.
setHostnames
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.comand*.bar.comto be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with*.bar.comor both withbar.com.
var
string[]
$this
getMeshes
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
setMeshes
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
var
string[]
$this
getGateways
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>
setGateways
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>
var
string[]
$this
getLabels
Optional. Set of label tags associated with the HttpRoute resource.
setLabels
Optional. Set of label tags associated with the HttpRoute resource.
$this
getRules
Required. Rules that define how traffic is routed and handled.
Rules will be matched sequentially based on the RouteMatch specified for the rule.
setRules
Required. Rules that define how traffic is routed and handled.
Rules will be matched sequentially based on the RouteMatch specified for the rule.
$this
