Class: Google::Apis::ComputeBeta::UrlMap

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_beta/classes.rb,
generated/google/apis/compute_beta/representations.rb,
generated/google/apis/compute_beta/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. 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

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ UrlMap

Returns a new instance of UrlMap.



32684
32685
32686
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32684

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

Returns:

  • (String) 


32580
32581
32582
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32580

def creation_timestamp
  @creation_timestamp
end

#default_route_action ⇒ Google::Apis::ComputeBeta::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. Corresponds to the JSON property defaultRouteAction

Returns:



32591
32592
32593
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32591

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. Corresponds to the JSON property defaultService

Returns:

  • (String) 


32604
32605
32606
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32604

def default_service
  @default_service
end

#default_url_redirect ⇒ Google::Apis::ComputeBeta::HttpRedirectAction

Specifies settings for an HTTP redirect. Corresponds to the JSON property defaultUrlRedirect

Returns:



32609
32610
32611
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32609

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

Returns:

  • (String) 


32615
32616
32617
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32615

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.

Returns:

  • (String) 


32626
32627
32628
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32626

def fingerprint
  @fingerprint
end

#header_action ⇒ Google::Apis::ComputeBeta::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

Returns:



32632
32633
32634
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32632

def header_action
  @header_action
end

#host_rules ⇒ Array<Google::Apis::ComputeBeta::HostRule>

The list of HostRules to use against the URL. Corresponds to the JSON property hostRules

Returns:



32637
32638
32639
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32637

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

Returns:

  • (Fixnum) 


32643
32644
32645
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32643

def id
  @id
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#urlMaps for url maps. Corresponds to the JSON property kind

Returns:

  • (String) 


32648
32649
32650
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32648

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

Returns:

  • (String) 


32658
32659
32660
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32658

def name
  @name
end

#path_matchers ⇒ Array<Google::Apis::ComputeBeta::PathMatcher>

The list of named PathMatchers to use against the URL. Corresponds to the JSON property pathMatchers

Returns:



32663
32664
32665
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32663

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

Returns:

  • (String) 


32670
32671
32672
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32670

def region
  @region
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


32675
32676
32677
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32675

def self_link
  @self_link
end

#tests ⇒ Array<Google::Apis::ComputeBeta::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. Corresponds to the JSON property tests

Returns:



32682
32683
32684
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32682

def tests
  @tests
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



32689
32690
32691
32692
32693
32694
32695
32696
32697
32698
32699
32700
32701
32702
32703
32704
32705
 
# File 'generated/google/apis/compute_beta/classes.rb', line 32689

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