url_maps

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

Overview

Name	url_maps
Type	Resource
Id	google.compute.url_maps

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	[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 withRFC1035. 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. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
creationTimestamp	string	Output only. [Output Only] Creation timestamp inRFC3339 text format.
defaultCustomErrorResponsePolicy	object	defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceorBackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a404, the policy inpathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a502, the policy inUrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction withdefaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, thedefaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers. (id: CustomErrorResponsePolicy)
defaultRouteAction	object	defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. (id: HttpRouteAction)
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. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. 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	When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy. (id: HttpRedirectAction)
description	string	An optional description of this resource. Provide this property when you create the resource.
fingerprint	string (byte)	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	Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect afterheaderAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. (id: HttpHeaderAction)
hostRules	array	The list of host rules to use against the URL.
kind	string	Output only. [Output Only] Type of the resource. Always compute#urlMaps for url maps. (default: compute#urlMap)
pathMatchers	array	The list of named PathMatchers to use against the URL.
region	string	Output only. [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 theUrlMap 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.

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of UrlMap resources.
kind	string	Output only. Type of resource. (default: compute#urlMapList)
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	Output only. [Output Only] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

aggregated_list

Name	Datatype	Description
id	string (uint64)	[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 withRFC1035. 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. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
creationTimestamp	string	Output only. [Output Only] Creation timestamp inRFC3339 text format.
defaultCustomErrorResponsePolicy	object	defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendServiceorBackendBucket responds with an error. This policy takes effect at the load balancer level and applies only when no policy has been defined for the error code at lower levels like PathMatcher, RouteRule and PathRule within this UrlMap. For example, consider a UrlMap with the following configuration: - defaultCustomErrorResponsePolicy containing policies for responding to 5xx and 4xx errors - A PathMatcher configured for *.example.com has defaultCustomErrorResponsePolicy for 4xx. If a request for http://www.example.com/ encounters a404, the policy inpathMatcher.defaultCustomErrorResponsePolicy will be enforced. When the request for http://www.example.com/ encounters a502, the policy inUrlMap.defaultCustomErrorResponsePolicy will be enforced. When a request that does not match any host in *.example.com such as http://www.myotherexample.com/, encounters a404, UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction withdefaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, thedefaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers. (id: CustomErrorResponsePolicy)
defaultRouteAction	object	defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. (id: HttpRouteAction)
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. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. 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	When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. Only one of defaultUrlRedirect, defaultService or defaultRouteAction.weightedBackendService can be set. Not supported when the URL map is bound to a target gRPC proxy. (id: HttpRedirectAction)
description	string	An optional description of this resource. Provide this property when you create the resource.
fingerprint	string (byte)	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	Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect afterheaderAction specified under pathMatcher. headerAction is not supported for load balancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. (id: HttpHeaderAction)
hostRules	array	The list of host rules to use against the URL.
kind	string	Output only. [Output Only] Type of the resource. Always compute#urlMaps for url maps. (default: compute#urlMap)
pathMatchers	array	The list of named PathMatchers to use against the URL.
region	string	Output only. [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 theUrlMap 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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, region, urlMap		Returns the specified UrlMap resource.
list	select	project, region	orderBy, filter, maxResults, pageToken, returnPartialSuccess	Retrieves the list of UrlMap resources available to the specified project in the specified region.
aggregated_list	select	project	filter, serviceProjectNumber, maxResults, pageToken, includeAllScopes, orderBy, returnPartialSuccess	Retrieves the list of all UrlMap resources, regional and global, available to the specified project. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
insert	insert	project, region	requestId	Creates a UrlMap resource in the specified project using the data included in the request.
patch	update	project, region, urlMap	requestId	Patches the specified UrlMap resource with the data included in the request. This method supportsPATCH semantics and usesJSON merge patch format and processing rules.
update	replace	project, region, urlMap	requestId	Updates the specified UrlMap resource with the data included in the request.
delete	delete	project, region, urlMap	requestId	Deletes the specified UrlMap resource.
validate	exec	project, region, 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.
invalidate_cache	exec	project, urlMap	requestId	Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see Invalidating cached content.

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
project	string
region	string
urlMap	string
filter	string
includeAllScopes	boolean
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean
serviceProjectNumber	string (int64)

SELECT examples

get

Returns the specified UrlMap resource.

SELECT
id,
name,
creationTimestamp,
defaultCustomErrorResponsePolicy,
defaultRouteAction,
defaultService,
defaultUrlRedirect,
description,
fingerprint,
headerAction,
hostRules,
kind,
pathMatchers,
region,
selfLink,
tests
FROM google.compute.url_maps
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND urlMap = '{{ urlMap }}' -- required
;

list

Retrieves the list of UrlMap resources available to the specified
project in the specified region.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.url_maps
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

aggregated_list

Retrieves the list of all UrlMap resources, regional and global,
available to the specified project.

To prevent failure, Google recommends that you set the
returnPartialSuccess parameter to true.

SELECT
id,
name,
creationTimestamp,
defaultCustomErrorResponsePolicy,
defaultRouteAction,
defaultService,
defaultUrlRedirect,
description,
fingerprint,
headerAction,
hostRules,
kind,
pathMatchers,
region,
selfLink,
tests
FROM google.compute.url_maps
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND serviceProjectNumber = '{{ serviceProjectNumber }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND includeAllScopes = '{{ includeAllScopes }}'
AND orderBy = '{{ orderBy }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

INSERT examples

insert

Creates a UrlMap resource in the specified project using
the data included in the request.

INSERT INTO google.compute.url_maps (
data__tests,
data__defaultCustomErrorResponsePolicy,
data__defaultService,
data__defaultRouteAction,
data__pathMatchers,
data__headerAction,
data__fingerprint,
data__description,
data__selfLink,
data__defaultUrlRedirect,
data__id,
data__hostRules,
data__name,
project,
region,
requestId
)
SELECT 
'{{ tests }}',
'{{ defaultCustomErrorResponsePolicy }}',
'{{ defaultService }}',
'{{ defaultRouteAction }}',
'{{ pathMatchers }}',
'{{ headerAction }}',
'{{ fingerprint }}',
'{{ description }}',
'{{ selfLink }}',
'{{ defaultUrlRedirect }}',
'{{ id }}',
'{{ hostRules }}',
'{{ name }}',
'{{ project }}',
'{{ region }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: url_maps
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the url_maps resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the url_maps resource.
  - name: tests
    description: |
      The list of expected URL mapping tests. Request to update theUrlMap 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.
    value:
      - expectedOutputUrl: "{{ expectedOutputUrl }}"
        expectedRedirectResponseCode: {{ expectedRedirectResponseCode }}
        path: "{{ path }}"
        description: "{{ description }}"
        host: "{{ host }}"
        headers: "{{ headers }}"
        service: "{{ service }}"
  - name: defaultCustomErrorResponsePolicy
    description: |
      defaultCustomErrorResponsePolicy specifies how the Load
      Balancer returns error responses when BackendServiceorBackendBucket responds with an error.
      This policy takes
      effect at the load balancer level and applies only when no policy has been
      defined for the error code at lower levels like PathMatcher, RouteRule and
      PathRule within this UrlMap.
      For example, consider a UrlMap with the
      following configuration:
      - defaultCustomErrorResponsePolicy containing policies for
      responding to 5xx and 4xx errors
      - A PathMatcher configured for *.example.com has
      defaultCustomErrorResponsePolicy for 4xx.
      If a request for http://www.example.com/ encounters a404, the policy inpathMatcher.defaultCustomErrorResponsePolicy will be enforced.
      When the request for http://www.example.com/ encounters a502, the policy inUrlMap.defaultCustomErrorResponsePolicy will be enforced. When
      a request that does not match any host in *.example.com such
      as http://www.myotherexample.com/, encounters a404, UrlMap.defaultCustomErrorResponsePolicy
      takes effect.
      When used in conjunction withdefaultRouteAction.retryPolicy, retries take precedence. Only
      once all retries are exhausted, thedefaultCustomErrorResponsePolicy is applied. While attempting
      a retry, if load balancer is successful in reaching the
      service, the defaultCustomErrorResponsePolicy is ignored and
      the response from the service is returned to the client.
      defaultCustomErrorResponsePolicy is supported only for
      global external Application Load Balancers.
    value:
      errorResponseRules:
        - matchResponseCodes: "{{ matchResponseCodes }}"
          path: "{{ path }}"
          overrideResponseCode: {{ overrideResponseCode }}
      errorService: "{{ errorService }}"
  - name: defaultService
    value: "{{ defaultService }}"
    description: |
      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.
      Only one of defaultUrlRedirect, defaultService
      or defaultRouteAction.weightedBackendService can be set.
      defaultService has no effect when the URL map is bound
      to a target gRPC proxy that has the validateForProxyless field
      set to true.
  - name: defaultRouteAction
    description: |
      defaultRouteAction takes effect when none of the
      hostRules match. The load balancer performs advanced routing
      actions, such as URL rewrites and header transformations, before forwarding
      the request to the selected backend.
      Only one of defaultUrlRedirect, defaultService
      or defaultRouteAction.weightedBackendService can be set.
      URL maps for classic Application Load Balancers only support
      the urlRewrite action within defaultRouteAction.
      defaultRouteAction has no effect when the URL map is bound
      to a target gRPC proxy that has the validateForProxyless field
      set to true.
    value:
      urlRewrite:
        hostRewrite: "{{ hostRewrite }}"
        pathTemplateRewrite: "{{ pathTemplateRewrite }}"
        pathPrefixRewrite: "{{ pathPrefixRewrite }}"
      retryPolicy:
        retryConditions:
          - "{{ retryConditions }}"
        numRetries: {{ numRetries }}
        perTryTimeout:
          nanos: {{ nanos }}
          seconds: "{{ seconds }}"
      faultInjectionPolicy:
        delay:
          fixedDelay:
            nanos: {{ nanos }}
            seconds: "{{ seconds }}"
          percentage: {{ percentage }}
        abort:
          percentage: {{ percentage }}
          httpStatus: {{ httpStatus }}
      weightedBackendServices:
        - backendService: "{{ backendService }}"
          headerAction:
            responseHeadersToAdd:
              - replace: {{ replace }}
                headerName: "{{ headerName }}"
                headerValue: "{{ headerValue }}"
            requestHeadersToRemove:
              - "{{ requestHeadersToRemove }}"
            responseHeadersToRemove:
              - "{{ responseHeadersToRemove }}"
            requestHeadersToAdd:
              - replace: {{ replace }}
                headerName: "{{ headerName }}"
                headerValue: "{{ headerValue }}"
          weight: {{ weight }}
      cachePolicy:
        maxTtl:
          nanos: {{ nanos }}
          seconds: "{{ seconds }}"
        clientTtl:
          nanos: {{ nanos }}
          seconds: "{{ seconds }}"
        serveWhileStale:
          nanos: {{ nanos }}
          seconds: "{{ seconds }}"
        cacheBypassRequestHeaderNames:
          - "{{ cacheBypassRequestHeaderNames }}"
        cacheMode: "{{ cacheMode }}"
        negativeCaching: {{ negativeCaching }}
        defaultTtl:
          nanos: {{ nanos }}
          seconds: "{{ seconds }}"
        requestCoalescing: {{ requestCoalescing }}
        cacheKeyPolicy:
          includedHeaderNames:
            - "{{ includedHeaderNames }}"
          includeHost: {{ includeHost }}
          excludedQueryParameters:
            - "{{ excludedQueryParameters }}"
          includedCookieNames:
            - "{{ includedCookieNames }}"
          includeProtocol: {{ includeProtocol }}
          includeQueryString: {{ includeQueryString }}
          includedQueryParameters:
            - "{{ includedQueryParameters }}"
        negativeCachingPolicy:
          - code: {{ code }}
            ttl:
              nanos: {{ nanos }}
              seconds: "{{ seconds }}"
      requestMirrorPolicy:
        backendService: "{{ backendService }}"
        mirrorPercent: {{ mirrorPercent }}
      corsPolicy:
        maxAge: {{ maxAge }}
        allowHeaders:
          - "{{ allowHeaders }}"
        allowOrigins:
          - "{{ allowOrigins }}"
        exposeHeaders:
          - "{{ exposeHeaders }}"
        allowMethods:
          - "{{ allowMethods }}"
        allowCredentials: {{ allowCredentials }}
        disabled: {{ disabled }}
        allowOriginRegexes:
          - "{{ allowOriginRegexes }}"
      timeout:
        nanos: {{ nanos }}
        seconds: "{{ seconds }}"
      maxStreamDuration:
        nanos: {{ nanos }}
        seconds: "{{ seconds }}"
  - name: pathMatchers
    description: |
      The list of named PathMatchers to use against the URL.
    value:
      - defaultCustomErrorResponsePolicy:
          errorResponseRules:
            - matchResponseCodes: "{{ matchResponseCodes }}"
              path: "{{ path }}"
              overrideResponseCode: {{ overrideResponseCode }}
          errorService: "{{ errorService }}"
        defaultService: "{{ defaultService }}"
        defaultRouteAction:
          urlRewrite:
            hostRewrite: "{{ hostRewrite }}"
            pathTemplateRewrite: "{{ pathTemplateRewrite }}"
            pathPrefixRewrite: "{{ pathPrefixRewrite }}"
          retryPolicy:
            retryConditions:
              - "{{ retryConditions }}"
            numRetries: {{ numRetries }}
            perTryTimeout:
              nanos: {{ nanos }}
              seconds: "{{ seconds }}"
          faultInjectionPolicy:
            delay:
              fixedDelay:
                nanos: {{ nanos }}
                seconds: "{{ seconds }}"
              percentage: {{ percentage }}
            abort:
              percentage: {{ percentage }}
              httpStatus: {{ httpStatus }}
          weightedBackendServices:
            - backendService: "{{ backendService }}"
              headerAction:
                responseHeadersToAdd:
                  - replace: {{ replace }}
                    headerName: "{{ headerName }}"
                    headerValue: "{{ headerValue }}"
                requestHeadersToRemove:
                  - "{{ requestHeadersToRemove }}"
                responseHeadersToRemove:
                  - "{{ responseHeadersToRemove }}"
                requestHeadersToAdd:
                  - replace: {{ replace }}
                    headerName: "{{ headerName }}"
                    headerValue: "{{ headerValue }}"
              weight: {{ weight }}
          cachePolicy:
            maxTtl:
              nanos: {{ nanos }}
              seconds: "{{ seconds }}"
            clientTtl:
              nanos: {{ nanos }}
              seconds: "{{ seconds }}"
            serveWhileStale:
              nanos: {{ nanos }}
              seconds: "{{ seconds }}"
            cacheBypassRequestHeaderNames:
              - "{{ cacheBypassRequestHeaderNames }}"
            cacheMode: "{{ cacheMode }}"
            negativeCaching: {{ negativeCaching }}
            defaultTtl:
              nanos: {{ nanos }}
              seconds: "{{ seconds }}"
            requestCoalescing: {{ requestCoalescing }}
            cacheKeyPolicy:
              includedHeaderNames:
                - "{{ includedHeaderNames }}"
              includeHost: {{ includeHost }}
              excludedQueryParameters:
                - "{{ excludedQueryParameters }}"
              includedCookieNames:
                - "{{ includedCookieNames }}"
              includeProtocol: {{ includeProtocol }}
              includeQueryString: {{ includeQueryString }}
              includedQueryParameters:
                - "{{ includedQueryParameters }}"
            negativeCachingPolicy:
              - code: {{ code }}
                ttl:
                  nanos: {{ nanos }}
                  seconds: "{{ seconds }}"
          requestMirrorPolicy:
            backendService: "{{ backendService }}"
            mirrorPercent: {{ mirrorPercent }}
          corsPolicy:
            maxAge: {{ maxAge }}
            allowHeaders:
              - "{{ allowHeaders }}"
            allowOrigins:
              - "{{ allowOrigins }}"
            exposeHeaders:
              - "{{ exposeHeaders }}"
            allowMethods:
              - "{{ allowMethods }}"
            allowCredentials: {{ allowCredentials }}
            disabled: {{ disabled }}
            allowOriginRegexes:
              - "{{ allowOriginRegexes }}"
          timeout:
            nanos: {{ nanos }}
            seconds: "{{ seconds }}"
          maxStreamDuration:
            nanos: {{ nanos }}
            seconds: "{{ seconds }}"
        defaultUrlRedirect:
          pathRedirect: "{{ pathRedirect }}"
          redirectResponseCode: "{{ redirectResponseCode }}"
          httpsRedirect: {{ httpsRedirect }}
          stripQuery: {{ stripQuery }}
          prefixRedirect: "{{ prefixRedirect }}"
          hostRedirect: "{{ hostRedirect }}"
        description: "{{ description }}"
        pathRules: "{{ pathRules }}"
        routeRules: "{{ routeRules }}"
        headerAction:
          responseHeadersToAdd:
            - replace: {{ replace }}
              headerName: "{{ headerName }}"
              headerValue: "{{ headerValue }}"
          requestHeadersToRemove:
            - "{{ requestHeadersToRemove }}"
          responseHeadersToRemove:
            - "{{ responseHeadersToRemove }}"
          requestHeadersToAdd:
            - replace: {{ replace }}
              headerName: "{{ headerName }}"
              headerValue: "{{ headerValue }}"
        name: "{{ name }}"
  - name: headerAction
    description: |
      Specifies changes to request and response headers that need to take effect
      for the selected backendService.
      The headerAction specified here take effect afterheaderAction specified under pathMatcher.
      headerAction is not supported for load balancers
      that have
      their loadBalancingScheme set to EXTERNAL.
      Not supported when the URL map is bound to a target gRPC proxy that
      has validateForProxyless field set to true.
    value:
      responseHeadersToAdd:
        - replace: {{ replace }}
          headerName: "{{ headerName }}"
          headerValue: "{{ headerValue }}"
      requestHeadersToRemove:
        - "{{ requestHeadersToRemove }}"
      responseHeadersToRemove:
        - "{{ responseHeadersToRemove }}"
      requestHeadersToAdd:
        - replace: {{ replace }}
          headerName: "{{ headerName }}"
          headerValue: "{{ headerValue }}"
  - name: fingerprint
    value: "{{ fingerprint }}"
    description: |
      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.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource. Provide this property when you
      create the resource.
  - name: selfLink
    value: "{{ selfLink }}"
    description: |
      [Output Only] Server-defined URL for the resource.
  - name: defaultUrlRedirect
    description: |
      When none of the specified hostRules match, the request
      is redirected to a URL specified by defaultUrlRedirect.
      Only one of defaultUrlRedirect, defaultService
      or defaultRouteAction.weightedBackendService can be set.
      Not supported when the URL map is bound to a target gRPC proxy.
    value:
      pathRedirect: "{{ pathRedirect }}"
      redirectResponseCode: "{{ redirectResponseCode }}"
      httpsRedirect: {{ httpsRedirect }}
      stripQuery: {{ stripQuery }}
      prefixRedirect: "{{ prefixRedirect }}"
      hostRedirect: "{{ hostRedirect }}"
  - name: id
    value: "{{ id }}"
    description: |
      [Output Only] The unique identifier for the resource. This identifier is
      defined by the server.
  - name: hostRules
    description: |
      The list of host rules to use against the URL.
    value:
      - hosts: "{{ hosts }}"
        description: "{{ description }}"
        pathMatcher: "{{ pathMatcher }}"
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. Provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      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.
  - name: requestId
    value: "{{ requestId }}"

UPDATE examples

patch

Patches the specified UrlMap resource with the data included in the
request. This method supportsPATCH
semantics and usesJSON merge
patch format and processing rules.

UPDATE google.compute.url_maps
SET 
data__tests = '{{ tests }}',
data__defaultCustomErrorResponsePolicy = '{{ defaultCustomErrorResponsePolicy }}',
data__defaultService = '{{ defaultService }}',
data__defaultRouteAction = '{{ defaultRouteAction }}',
data__pathMatchers = '{{ pathMatchers }}',
data__headerAction = '{{ headerAction }}',
data__fingerprint = '{{ fingerprint }}',
data__description = '{{ description }}',
data__selfLink = '{{ selfLink }}',
data__defaultUrlRedirect = '{{ defaultUrlRedirect }}',
data__id = '{{ id }}',
data__hostRules = '{{ hostRules }}',
data__name = '{{ name }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND urlMap = '{{ urlMap }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

REPLACE examples

update

Updates the specified UrlMap resource with the data included in the
request.

REPLACE google.compute.url_maps
SET 
data__tests = '{{ tests }}',
data__defaultCustomErrorResponsePolicy = '{{ defaultCustomErrorResponsePolicy }}',
data__defaultService = '{{ defaultService }}',
data__defaultRouteAction = '{{ defaultRouteAction }}',
data__pathMatchers = '{{ pathMatchers }}',
data__headerAction = '{{ headerAction }}',
data__fingerprint = '{{ fingerprint }}',
data__description = '{{ description }}',
data__selfLink = '{{ selfLink }}',
data__defaultUrlRedirect = '{{ defaultUrlRedirect }}',
data__id = '{{ id }}',
data__hostRules = '{{ hostRules }}',
data__name = '{{ name }}'
WHERE 
project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND urlMap = '{{ urlMap }}' --required
AND requestId = '{{ requestId}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples

delete

Deletes the specified UrlMap resource.

DELETE FROM google.compute.url_maps
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND urlMap = '{{ urlMap }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods

validate

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.

EXEC google.compute.url_maps.validate 
@project='{{ project }}' --required, 
@region='{{ region }}' --required, 
@urlMap='{{ urlMap }}' --required 
@@json=
'{
"resource": "{{ resource }}"
}'
;

invalidate_cache

Initiates a cache invalidation operation, invalidating the specified path,
scoped to the specified UrlMap.

For more information, see Invalidating cached
content.

EXEC google.compute.url_maps.invalidate_cache 
@project='{{ project }}' --required, 
@urlMap='{{ urlMap }}' --required, 
@requestId='{{ requestId }}' 
@@json=
'{
"path": "{{ path }}", 
"cacheTags": "{{ cacheTags }}", 
"host": "{{ host }}"
}'
;