http_routes

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

Overview

Name	http_routes
Type	Resource
Id	google.networkservices.http_routes

Fields

Name	Datatype	Description
name	string	Identifier. Name of the HttpRoute resource. It matches pattern projects/*/locations/global/httpRoutes/http_route_name>.
description	string	Optional. A free-text description of the resource. Max length 1024 characters.
createTime	string	Output only. The timestamp when the resource was created.
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	Output only. The timestamp when the resource was updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	httpRoutesId, locationsId, projectsId	Gets details of a single HttpRoute.
list	SELECT	locationsId, projectsId	Lists HttpRoute in a given project and location.
create	INSERT	locationsId, projectsId	Creates a new HttpRoute in a given project and location.
delete	DELETE	httpRoutesId, locationsId, projectsId	Deletes a single HttpRoute.
patch	UPDATE	httpRoutesId, locationsId, projectsId	Updates the parameters of a single HttpRoute.

SELECT examples

Lists HttpRoute in a given project and location.

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

INSERT example

Use the following StackQL query and manifest file to create a new http_routes resource.

All Properties

/*+ create */
INSERT INTO google.networkservices.http_routes (
locationsId,
projectsId,
name,
description,
hostnames,
meshes,
gateways,
labels,
rules
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ name }}',
'{{ description }}',
'{{ hostnames }}',
'{{ meshes }}',
'{{ gateways }}',
'{{ labels }}',
'{{ rules }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: selfLink
      value: string
    - name: description
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: hostnames
      value:
        - string
    - name: meshes
      value:
        - string
    - name: gateways
      value:
        - string
    - name: labels
      value: object
    - name: rules
      value:
        - - name: matches
            value:
              - - name: fullPathMatch
                  value: string
                - name: prefixMatch
                  value: string
                - name: regexMatch
                  value: string
                - name: ignoreCase
                  value: boolean
                - name: headers
                  value:
                    - - name: exactMatch
                        value: string
                      - name: regexMatch
                        value: string
                      - name: prefixMatch
                        value: string
                      - name: presentMatch
                        value: boolean
                      - name: suffixMatch
                        value: string
                      - name: rangeMatch
                        value:
                          - name: start
                            value: integer
                          - name: end
                            value: integer
                      - name: header
                        value: string
                      - name: invertMatch
                        value: boolean
                - name: queryParameters
                  value:
                    - - name: exactMatch
                        value: string
                      - name: regexMatch
                        value: string
                      - name: presentMatch
                        value: boolean
                      - name: queryParameter
                        value: string
          - name: action
            value:
              - name: destinations
                value:
                  - - name: serviceName
                      value: string
                    - name: weight
                      value: integer
                    - name: requestHeaderModifier
                      value:
                        - name: set
                          value: object
                        - name: add
                          value: object
                        - name: remove
                          value:
                            - string
              - name: redirect
                value:
                  - name: hostRedirect
                    value: string
                  - name: pathRedirect
                    value: string
                  - name: prefixRewrite
                    value: string
                  - name: responseCode
                    value: string
                  - name: httpsRedirect
                    value: boolean
                  - name: stripQuery
                    value: boolean
                  - name: portRedirect
                    value: integer
              - name: faultInjectionPolicy
                value:
                  - name: delay
                    value:
                      - name: fixedDelay
                        value: string
                      - name: percentage
                        value: integer
                  - name: abort
                    value:
                      - name: httpStatus
                        value: integer
                      - name: percentage
                        value: integer
              - name: urlRewrite
                value:
                  - name: pathPrefixRewrite
                    value: string
                  - name: hostRewrite
                    value: string
              - name: timeout
                value: string
              - name: retryPolicy
                value:
                  - name: retryConditions
                    value:
                      - string
                  - name: numRetries
                    value: integer
                  - name: perTryTimeout
                    value: string
              - name: requestMirrorPolicy
                value:
                  - name: destination
                    value:
                      - name: serviceName
                        value: string
                      - name: weight
                        value: integer
                  - name: mirrorPercent
                    value: number
              - name: corsPolicy
                value:
                  - name: allowOrigins
                    value:
                      - string
                  - name: allowOriginRegexes
                    value:
                      - string
                  - name: allowMethods
                    value:
                      - string
                  - name: allowHeaders
                    value:
                      - string
                  - name: exposeHeaders
                    value:
                      - string
                  - name: maxAge
                    value: string
                  - name: allowCredentials
                    value: boolean
                  - name: disabled
                    value: boolean
              - name: statefulSessionAffinity
                value:
                  - name: cookieTtl
                    value: string
              - name: directResponse
                value:
                  - name: stringBody
                    value: string
                  - name: bytesBody
                    value: string
                  - name: status
                    value: integer
              - name: idleTimeout
                value: string

UPDATE example

Updates a http_routes resource.

/*+ update */
UPDATE google.networkservices.http_routes
SET 
name = '{{ name }}',
description = '{{ description }}',
hostnames = '{{ hostnames }}',
meshes = '{{ meshes }}',
gateways = '{{ gateways }}',
labels = '{{ labels }}',
rules = '{{ rules }}'
WHERE 
httpRoutesId = '{{ httpRoutesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified http_routes resource.

/*+ delete */
DELETE FROM google.networkservices.http_routes
WHERE httpRoutesId = '{{ httpRoutesId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';