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.
42769 42770 42771 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42769 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
42657 42658 42659 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42657 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
42672 42673 42674 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42672 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
42687 42688 42689 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42687 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
42692 42693 42694 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42692 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
42698 42699 42700 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42698 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.
42709 42710 42711 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42709 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
42715 42716 42717 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42715 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
42720 42721 42722 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42720 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
42726 42727 42728 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42726 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#urlMaps for url maps.
Corresponds to the JSON property kind
42731 42732 42733 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42731 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
42741 42742 42743 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42741 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
42746 42747 42748 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42746 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
42753 42754 42755 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42753 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
42758 42759 42760 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42758 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
42767 42768 42769 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42767 def tests @tests end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
42774 42775 42776 42777 42778 42779 42780 42781 42782 42783 42784 42785 42786 42787 42788 42789 42790 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42774 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 |