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.
42568 42569 42570 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42568 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
42456 42457 42458 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42456 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
42471 42472 42473 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42471 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
42486 42487 42488 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42486 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
42491 42492 42493 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42491 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
42497 42498 42499 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42497 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.
42508 42509 42510 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42508 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
42514 42515 42516 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42514 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
42519 42520 42521 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42519 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
42525 42526 42527 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42525 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#urlMaps for url maps.
Corresponds to the JSON property kind
42530 42531 42532 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42530 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
42540 42541 42542 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42540 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
42545 42546 42547 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42545 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
42552 42553 42554 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42552 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
42557 42558 42559 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42557 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
42566 42567 42568 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42566 def tests @tests end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
42573 42574 42575 42576 42577 42578 42579 42580 42581 42582 42583 42584 42585 42586 42587 42588 42589 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42573 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 |