url_maps
Creates, updates, deletes, gets or lists a url_maps resource.
Overview
| Name | url_maps |
| Type | Resource |
| Id | google.compute.url_maps |
Fields
| Name | Datatype | Description |
|---|---|---|
id | string | [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
name | string | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. |
description | string | An optional description of this resource. Provide this property when you create the resource. |
creationTimestamp | string | [Output Only] Creation timestamp in RFC3339 text format. |
defaultCustomErrorResponsePolicy | object | Specifies the custom error response policy that must be applied when the backend service or backend bucket responds with an error. |
defaultRouteAction | object | |
defaultService | string | The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any defaultRouteAction.weightedBackendServices. Conversely, if defaultRouteAction specifies any defaultRouteAction.weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. |
defaultUrlRedirect | object | Specifies settings for an HTTP redirect. |
fingerprint | string | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. |
headerAction | object | The request and response header transformations that take effect before the request is passed along to the selected backendService. |
hostRules | array | The list of host rules to use against the URL. |
kind | string | [Output Only] Type of the resource. Always compute#urlMaps for url maps. |
pathMatchers | array | The list of named PathMatchers to use against the URL. |
region | string | [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. |
selfLink | string | [Output Only] Server-defined URL for the resource. |
tests | array | The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get | SELECT | project, urlMap | Returns the specified UrlMap resource. |
list | SELECT | project | Retrieves the list of UrlMap resources available to the specified project. |
insert | INSERT | project | Creates a UrlMap resource in the specified project using the data included in the request. |
delete | DELETE | project, urlMap | Deletes the specified UrlMap resource. |
patch | UPDATE | project, urlMap | Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. |
update | REPLACE | project, urlMap | Updates the specified UrlMap resource with the data included in the request. |
invalidate_cache | EXEC | project, urlMap | Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content. |
validate | EXEC | project, urlMap | Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. |
SELECT examples
Retrieves the list of UrlMap resources available to the specified project.
SELECT
id,
name,
description,
creationTimestamp,
defaultCustomErrorResponsePolicy,
defaultRouteAction,
defaultService,
defaultUrlRedirect,
fingerprint,
headerAction,
hostRules,
kind,
pathMatchers,
region,
selfLink,
tests
FROM google.compute.url_maps
WHERE project = '{{ project }}';
INSERT example
Use the following StackQL query and manifest file to create a new url_maps resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO google.compute.url_maps (
project,
name,
description,
hostRules,
pathMatchers,
tests,
defaultService,
defaultRouteAction,
defaultUrlRedirect,
headerAction,
defaultCustomErrorResponsePolicy,
fingerprint,
region
)
SELECT
'{{ project }}',
'{{ name }}',
'{{ description }}',
'{{ hostRules }}',
'{{ pathMatchers }}',
'{{ tests }}',
'{{ defaultService }}',
'{{ defaultRouteAction }}',
'{{ defaultUrlRedirect }}',
'{{ headerAction }}',
'{{ defaultCustomErrorResponsePolicy }}',
'{{ fingerprint }}',
'{{ region }}'
;
- name: your_resource_model_name
props:
- name: kind
value: string
- name: id
value: string
- name: creationTimestamp
value: string
- name: name
value: string
- name: description
value: string
- name: selfLink
value: string
- name: hostRules
value:
- - name: description
value: string
- name: hosts
value:
- string
- name: pathMatcher
value: string
- name: pathMatchers
value:
- - name: name
value: string
- name: description
value: string
- name: defaultService
value: string
- name: defaultRouteAction
value:
- name: weightedBackendServices
value:
- - name: backendService
value: string
- name: weight
value: integer
- name: headerAction
value:
- name: requestHeadersToRemove
value:
- string
- name: requestHeadersToAdd
value:
- - name: headerName
value: string
- name: headerValue
value: string
- name: replace
value: boolean
- name: responseHeadersToRemove
value:
- string
- name: responseHeadersToAdd
value:
- - name: headerName
value: string
- name: headerValue
value: string
- name: replace
value: boolean
- name: urlRewrite
value:
- name: pathPrefixRewrite
value: string
- name: hostRewrite
value: string
- name: pathTemplateRewrite
value: string
- name: timeout
value:
- name: seconds
value: string
- name: nanos
value: integer
- name: retryPolicy
value:
- name: retryConditions
value:
- string
- name: numRetries
value: integer
- name: requestMirrorPolicy
value:
- name: backendService
value: string
- 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: integer
- name: allowCredentials
value: boolean
- name: disabled
value: boolean
- name: faultInjectionPolicy
value:
- name: delay
value:
- name: percentage
value: number
- name: abort
value:
- name: httpStatus
value: integer
- name: percentage
value: number
- name: defaultUrlRedirect
value:
- name: hostRedirect
value: string
- name: pathRedirect
value: string
- name: prefixRedirect
value: string
- name: redirectResponseCode
value: string
- name: httpsRedirect
value: boolean
- name: stripQuery
value: boolean
- name: pathRules
value:
- - name: service
value: string
- name: paths
value:
- string
- name: customErrorResponsePolicy
value:
- name: errorResponseRules
value:
- - name: matchResponseCodes
value:
- string
- name: path
value: string
- name: overrideResponseCode
value: integer
- name: errorService
value: string
- name: routeRules
value:
- - name: priority
value: integer
- name: description
value: string
- name: matchRules
value:
- - name: prefixMatch
value: string
- name: fullPathMatch
value: string
- name: regexMatch
value: string
- name: ignoreCase
value: boolean
- name: headerMatches
value:
- - name: headerName
value: string
- name: exactMatch
value: string
- name: regexMatch
value: string
- name: rangeMatch
value:
- name: rangeStart
value: string
- name: rangeEnd
value: string
- name: presentMatch
value: boolean
- name: prefixMatch
value: string
- name: suffixMatch
value: string
- name: invertMatch
value: boolean
- name: queryParameterMatches
value:
- - name: name
value: string
- name: presentMatch
value: boolean
- name: exactMatch
value: string
- name: regexMatch
value: string
- name: metadataFilters
value:
- - name: filterMatchCriteria
value: string
- name: filterLabels
value:
- - name: name
value: string
- name: value
value: string
- name: pathTemplateMatch
value: string
- name: service
value: string
- name: tests
value:
- - name: description
value: string
- name: host
value: string
- name: path
value: string
- name: headers
value:
- - name: name
value: string
- name: value
value: string
- name: service
value: string
- name: expectedOutputUrl
value: string
- name: expectedRedirectResponseCode
value: integer
- name: defaultService
value: string
- name: fingerprint
value: string
- name: region
value: string
UPDATE example
Updates a url_maps resource.
/*+ update */
UPDATE google.compute.url_maps
SET
name = '{{ name }}',
description = '{{ description }}',
hostRules = '{{ hostRules }}',
pathMatchers = '{{ pathMatchers }}',
tests = '{{ tests }}',
defaultService = '{{ defaultService }}',
defaultRouteAction = '{{ defaultRouteAction }}',
defaultUrlRedirect = '{{ defaultUrlRedirect }}',
headerAction = '{{ headerAction }}',
defaultCustomErrorResponsePolicy = '{{ defaultCustomErrorResponsePolicy }}',
fingerprint = '{{ fingerprint }}',
region = '{{ region }}'
WHERE
project = '{{ project }}'
AND urlMap = '{{ urlMap }}';
REPLACE example
Replaces all fields in the specified url_maps resource.
/*+ update */
REPLACE google.compute.url_maps
SET
name = '{{ name }}',
description = '{{ description }}',
hostRules = '{{ hostRules }}',
pathMatchers = '{{ pathMatchers }}',
tests = '{{ tests }}',
defaultService = '{{ defaultService }}',
defaultRouteAction = '{{ defaultRouteAction }}',
defaultUrlRedirect = '{{ defaultUrlRedirect }}',
headerAction = '{{ headerAction }}',
defaultCustomErrorResponsePolicy = '{{ defaultCustomErrorResponsePolicy }}',
fingerprint = '{{ fingerprint }}',
region = '{{ region }}'
WHERE
project = '{{ project }}'
AND urlMap = '{{ urlMap }}';
DELETE example
Deletes the specified url_maps resource.
/*+ delete */
DELETE FROM google.compute.url_maps
WHERE project = '{{ project }}'
AND urlMap = '{{ urlMap }}';