compute  v1
Properties | List of all members
Google.Apis.Compute.v1.Data.UrlMap Class Reference

Represents a URL Map resource. More...

Inheritance diagram for Google.Apis.Compute.v1.Data.UrlMap:
Google::Apis::Requests::IDirectResponseSchema

Properties

virtual string CreationTimestamp [get, set]
 [Output Only] Creation timestamp in RFC3339 text format. More...
 
virtual HttpRouteAction DefaultRouteAction [get, set]
 defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. More...
 
virtual string DefaultService [get, set]
 The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. More...
 
virtual HttpRedirectAction DefaultUrlRedirect [get, set]
 When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. More...
 
virtual string Description [get, set]
 An optional description of this resource. Provide this property when you create the resource. More...
 
virtual string Fingerprint [get, set]
 Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be 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. More...
 
virtual HttpHeaderAction HeaderAction [get, set]
 Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. More...
 
virtual System.Collections.Generic.IList< HostRuleHostRules [get, set]
 The list of HostRules to use against the URL. More...
 
virtual System.Nullable< ulong > Id [get, set]
 [Output Only] The unique identifier for the resource. This identifier is defined by the server. More...
 
virtual string Kind [get, set]
 [Output Only] Type of the resource. Always compute::urlMaps for url maps. More...
 
virtual string Name [get, set]
 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. More...
 
virtual System.Collections.Generic.IList< PathMatcherPathMatchers [get, set]
 The list of named PathMatchers to use against the URL. More...
 
virtual string Region [get, set]
 [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. More...
 
virtual string SelfLink [get, set]
 [Output Only] Server-defined URL for the resource. More...
 
virtual System.Collections.Generic.IList< UrlMapTestTests [get, set]
 The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. More...
 
virtual string ETag [get, set]
 The ETag of the item. More...
 
- Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string ETag
 

Detailed Description

Represents a URL Map resource.

Google Compute Engine has two URL Map resources:

A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.

Property Documentation

◆ CreationTimestamp

virtual string Google.Apis.Compute.v1.Data.UrlMap.CreationTimestamp
getset

[Output Only] Creation timestamp in RFC3339 text format.

◆ DefaultRouteAction

virtual HttpRouteAction Google.Apis.Compute.v1.Data.UrlMap.DefaultRouteAction
getset

defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set.

◆ DefaultService

virtual string Google.Apis.Compute.v1.Data.UrlMap.DefaultService
getset

The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

◆ DefaultUrlRedirect

virtual HttpRedirectAction Google.Apis.Compute.v1.Data.UrlMap.DefaultUrlRedirect
getset

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

◆ Description

virtual string Google.Apis.Compute.v1.Data.UrlMap.Description
getset

An optional description of this resource. Provide this property when you create the resource.

◆ ETag

virtual string Google.Apis.Compute.v1.Data.UrlMap.ETag
getset

The ETag of the item.

◆ Fingerprint

virtual string Google.Apis.Compute.v1.Data.UrlMap.Fingerprint
getset

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be 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

virtual HttpHeaderAction Google.Apis.Compute.v1.Data.UrlMap.HeaderAction
getset

Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher.

◆ HostRules

virtual System.Collections.Generic.IList<HostRule> Google.Apis.Compute.v1.Data.UrlMap.HostRules
getset

The list of HostRules to use against the URL.

◆ Id

virtual System.Nullable<ulong> Google.Apis.Compute.v1.Data.UrlMap.Id
getset

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

◆ Kind

virtual string Google.Apis.Compute.v1.Data.UrlMap.Kind
getset

[Output Only] Type of the resource. Always compute::urlMaps for url maps.

◆ Name

virtual string Google.Apis.Compute.v1.Data.UrlMap.Name
getset

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.

◆ PathMatchers

virtual System.Collections.Generic.IList<PathMatcher> Google.Apis.Compute.v1.Data.UrlMap.PathMatchers
getset

The list of named PathMatchers to use against the URL.

◆ Region

virtual string Google.Apis.Compute.v1.Data.UrlMap.Region
getset

[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

virtual string Google.Apis.Compute.v1.Data.UrlMap.SelfLink
getset

[Output Only] Server-defined URL for the resource.

◆ Tests

virtual System.Collections.Generic.IList<UrlMapTest> Google.Apis.Compute.v1.Data.UrlMap.Tests
getset

The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap.


The documentation for this class was generated from the following file: