Class: Google::Apis::ComputeAlpha::UrlMap
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::UrlMap
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb
Overview
Represents a URL Map resource. Google Compute Engine has two URL Map resources:
- Global * Regional A URL map resource is a component of certain types of GCP load balancers and Traffic Director. * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. 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.
Instance Attribute Summary collapse
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#default_route_action ⇒ Google::Apis::ComputeAlpha::HttpRouteAction
defaultRouteAction takes effect when none of the hostRules match.
-
#default_service ⇒ String
The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match.
-
#default_url_redirect ⇒ Google::Apis::ComputeAlpha::HttpRedirectAction
Specifies settings for an HTTP redirect.
-
#description ⇒ String
An optional description of this resource.
-
#fingerprint ⇒ String
Fingerprint of this resource.
-
#header_action ⇒ Google::Apis::ComputeAlpha::HttpHeaderAction
The request and response header transformations that take effect before the request is passed along to the selected backendService.
-
#host_rules ⇒ Array<Google::Apis::ComputeAlpha::HostRule>
The list of HostRules to use against the URL.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#name ⇒ String
Name of the resource.
-
#path_matchers ⇒ Array<Google::Apis::ComputeAlpha::PathMatcher>
The list of named PathMatchers to use against the URL.
-
#region ⇒ String
[Output Only] URL of the region where the regional URL map resides.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#tests ⇒ Array<Google::Apis::ComputeAlpha::UrlMapTest>
The list of expected URL mapping tests.
Instance Method Summary collapse
-
#initialize(**args) ⇒ UrlMap
constructor
A new instance of UrlMap.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ UrlMap
Returns a new instance of UrlMap.
44172 44173 44174 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44172 def initialize(**args) update!(**args) end |
Instance Attribute Details
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
44063 44064 44065 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44063 def @creation_timestamp end |
#default_route_action ⇒ Google::Apis::ComputeAlpha::HttpRouteAction
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. UrlMaps for external HTTP(S) load balancers
support only the urlRewrite action within defaultRouteAction.
defaultRouteAction has no effect when the URL map is bound to target gRPC
proxy that has validateForProxyless field set to true.
Corresponds to the JSON property defaultRouteAction
44077 44078 44079 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44077 def default_route_action @default_route_action end |
#default_service ⇒ String
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. defaultService has no
effect when the URL map is bound to target gRPC proxy that has
validateForProxyless field set to true.
Corresponds to the JSON property defaultService
44091 44092 44093 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44091 def default_service @default_service end |
#default_url_redirect ⇒ Google::Apis::ComputeAlpha::HttpRedirectAction
Specifies settings for an HTTP redirect.
Corresponds to the JSON property defaultUrlRedirect
44096 44097 44098 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44096 def default_url_redirect @default_url_redirect end |
#description ⇒ String
An optional description of this resource. Provide this property when you
create the resource.
Corresponds to the JSON property description
44102 44103 44104 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44102 def description @description end |
#fingerprint ⇒ String
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.
Corresponds to the JSON property fingerprint
NOTE: Values are automatically base64 encoded/decoded in the client library.
44113 44114 44115 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44113 def fingerprint @fingerprint end |
#header_action ⇒ Google::Apis::ComputeAlpha::HttpHeaderAction
The request and response header transformations that take effect before the
request is passed along to the selected backendService.
Corresponds to the JSON property headerAction
44119 44120 44121 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44119 def header_action @header_action end |
#host_rules ⇒ Array<Google::Apis::ComputeAlpha::HostRule>
The list of HostRules to use against the URL.
Corresponds to the JSON property hostRules
44124 44125 44126 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44124 def host_rules @host_rules end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
44130 44131 44132 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44130 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#urlMaps for url maps.
Corresponds to the JSON property kind
44135 44136 44137 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44135 def kind @kind end |
#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.
Corresponds to the JSON property name
44145 44146 44147 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44145 def name @name end |
#path_matchers ⇒ Array<Google::Apis::ComputeAlpha::PathMatcher>
The list of named PathMatchers to use against the URL.
Corresponds to the JSON property pathMatchers
44150 44151 44152 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44150 def path_matchers @path_matchers end |
#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.
Corresponds to the JSON property region
44157 44158 44159 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44157 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
44162 44163 44164 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44162 def self_link @self_link end |
#tests ⇒ Array<Google::Apis::ComputeAlpha::UrlMapTest>
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. Not supported when the URL map is bound to target gRPC proxy
that has validateForProxyless field set to true.
Corresponds to the JSON property tests
44170 44171 44172 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44170 def tests @tests end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
44177 44178 44179 44180 44181 44182 44183 44184 44185 44186 44187 44188 44189 44190 44191 44192 44193 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44177 def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @default_route_action = args[:default_route_action] if args.key?(:default_route_action) @default_service = args[:default_service] if args.key?(:default_service) @default_url_redirect = args[:default_url_redirect] if args.key?(:default_url_redirect) @description = args[:description] if args.key?(:description) @fingerprint = args[:fingerprint] if args.key?(:fingerprint) @header_action = args[:header_action] if args.key?(:header_action) @host_rules = args[:host_rules] if args.key?(:host_rules) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @path_matchers = args[:path_matchers] if args.key?(:path_matchers) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @tests = args[:tests] if args.key?(:tests) end |