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. A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or 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



29218
29219
29220
# File 'generated/google/apis/compute_beta/classes.rb', line 29218

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#creation_timestampString

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String)


29114
29115
29116
# File 'generated/google/apis/compute_beta/classes.rb', line 29114

def creation_timestamp
  @creation_timestamp
end

#default_route_actionGoogle::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



29125
29126
29127
# File 'generated/google/apis/compute_beta/classes.rb', line 29125

def default_route_action
  @default_route_action
end

#default_serviceString

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)


29138
29139
29140
# File 'generated/google/apis/compute_beta/classes.rb', line 29138

def default_service
  @default_service
end

#default_url_redirectGoogle::Apis::ComputeBeta::HttpRedirectAction

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



29143
29144
29145
# File 'generated/google/apis/compute_beta/classes.rb', line 29143

def default_url_redirect
  @default_url_redirect
end

#descriptionString

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

Returns:

  • (String)


29149
29150
29151
# File 'generated/google/apis/compute_beta/classes.rb', line 29149

def description
  @description
end

#fingerprintString

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)


29160
29161
29162
# File 'generated/google/apis/compute_beta/classes.rb', line 29160

def fingerprint
  @fingerprint
end

#header_actionGoogle::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



29166
29167
29168
# File 'generated/google/apis/compute_beta/classes.rb', line 29166

def header_action
  @header_action
end

#host_rulesArray<Google::Apis::ComputeBeta::HostRule>

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



29171
29172
29173
# File 'generated/google/apis/compute_beta/classes.rb', line 29171

def host_rules
  @host_rules
end

#idFixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum)


29177
29178
29179
# File 'generated/google/apis/compute_beta/classes.rb', line 29177

def id
  @id
end

#kindString

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

Returns:

  • (String)


29182
29183
29184
# File 'generated/google/apis/compute_beta/classes.rb', line 29182

def kind
  @kind
end

#nameString

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)


29192
29193
29194
# File 'generated/google/apis/compute_beta/classes.rb', line 29192

def name
  @name
end

#path_matchersArray<Google::Apis::ComputeBeta::PathMatcher>

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



29197
29198
29199
# File 'generated/google/apis/compute_beta/classes.rb', line 29197

def path_matchers
  @path_matchers
end

#regionString

[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)


29204
29205
29206
# File 'generated/google/apis/compute_beta/classes.rb', line 29204

def region
  @region
end

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

Returns:

  • (String)


29209
29210
29211
# File 'generated/google/apis/compute_beta/classes.rb', line 29209

def self_link
  @self_link
end

#testsArray<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



29216
29217
29218
# File 'generated/google/apis/compute_beta/classes.rb', line 29216

def tests
  @tests
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



29223
29224
29225
29226
29227
29228
29229
29230
29231
29232
29233
29234
29235
29236
29237
29238
29239
# File 'generated/google/apis/compute_beta/classes.rb', line 29223

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