http_routes

Creates, updates, deletes, gets or lists a http_routes resource.

Overview

Name	http_routes
Type	Resource
Id	google.networkservices.http_routes

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the HttpRoute resource. It matches pattern projects/*/locations/global/httpRoutes/http_route_name>.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. A free-text description of the resource. Max length 1024 characters.
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/
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.
labels	object	Optional. Set of label tags associated with the HttpRoute resource.
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/ The attached Mesh should be of a type SIDECAR
rules	array	Required. Rules that define how traffic is routed and handled. Rules will be matched sequentially based on the RouteMatch specified for the rule.
selfLink	string	Output only. Server-defined URL of this resource
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the HttpRoute resource. It matches pattern projects/*/locations/global/httpRoutes/http_route_name>.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. A free-text description of the resource. Max length 1024 characters.
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/
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.
labels	object	Optional. Set of label tags associated with the HttpRoute resource.
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/ The attached Mesh should be of a type SIDECAR
rules	array	Required. Rules that define how traffic is routed and handled. Rules will be matched sequentially based on the RouteMatch specified for the rule.
selfLink	string	Output only. Server-defined URL of this resource
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, httpRoutesId		Gets details of a single HttpRoute.
list	select	projectsId, locationsId	pageSize, pageToken, returnPartialSuccess	Lists HttpRoute in a given project and location.
create	insert	projectsId, locationsId	httpRouteId	Creates a new HttpRoute in a given project and location.
patch	update	projectsId, locationsId, httpRoutesId	updateMask	Updates the parameters of a single HttpRoute.
delete	delete	projectsId, locationsId, httpRoutesId		Deletes a single HttpRoute.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
httpRoutesId	string
locationsId	string
projectsId	string
httpRouteId	string
pageSize	integer (int32)
pageToken	string
returnPartialSuccess	boolean
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single HttpRoute.

SELECT
name,
createTime,
description,
gateways,
hostnames,
labels,
meshes,
rules,
selfLink,
updateTime
FROM google.networkservices.http_routes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND httpRoutesId = '{{ httpRoutesId }}' -- required;

list

Lists HttpRoute in a given project and location.

SELECT
name,
createTime,
description,
gateways,
hostnames,
labels,
meshes,
rules,
selfLink,
updateTime
FROM google.networkservices.http_routes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

INSERT examples

create

Creates a new HttpRoute in a given project and location.

INSERT INTO google.networkservices.http_routes (
data__name,
data__description,
data__hostnames,
data__meshes,
data__gateways,
data__labels,
data__rules,
projectsId,
locationsId,
httpRouteId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ hostnames }}',
'{{ meshes }}',
'{{ gateways }}',
'{{ labels }}',
'{{ rules }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ httpRouteId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: http_routes
  props:
    - name: projectsId
      value: string
      description: Required parameter for the http_routes resource.
    - name: locationsId
      value: string
      description: Required parameter for the http_routes resource.
    - name: name
      value: string
      description: >
        Identifier. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.
        
    - name: description
      value: string
      description: >
        Optional. A free-text description of the resource. Max length 1024 characters.
        
    - name: hostnames
      value: array
      description: >
        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`.
        
    - name: meshes
      value: array
      description: >
        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/` The attached Mesh should be of a type SIDECAR
        
    - name: gateways
      value: array
      description: >
        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/`
        
    - name: labels
      value: object
      description: >
        Optional. Set of label tags associated with the HttpRoute resource.
        
    - name: rules
      value: array
      description: >
        Required. Rules that define how traffic is routed and handled. Rules will be matched sequentially based on the RouteMatch specified for the rule.
        
    - name: httpRouteId
      value: string

UPDATE examples

patch

Updates the parameters of a single HttpRoute.

UPDATE google.networkservices.http_routes
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__hostnames = '{{ hostnames }}',
data__meshes = '{{ meshes }}',
data__gateways = '{{ gateways }}',
data__labels = '{{ labels }}',
data__rules = '{{ rules }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND httpRoutesId = '{{ httpRoutesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single HttpRoute.

DELETE FROM google.networkservices.http_routes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND httpRoutesId = '{{ httpRoutesId }}' --required;