Class: Google::Apis::ComputeBeta::PathMatcher

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

A matcher for the path portion of the URL. The BackendService from the longest- matched rule will serve the URL. If no rule was matched, the default service will be used.

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) ⇒ PathMatcher

Returns a new instance of PathMatcher



18996
18997
18998
 
# File 'generated/google/apis/compute_beta/classes.rb', line 18996

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

Instance Attribute Details

#default_route_action ⇒ Google::Apis::ComputeBeta::HttpRouteAction

defaultRouteAction takes effect when none of the pathRules or routeRules 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:



18930
18931
18932
 
# File 'generated/google/apis/compute_beta/classes.rb', line 18930

def default_route_action
  @default_route_action
end

#default_service ⇒ String

The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource:

  • https://www.googleapis.com/compute/v1/projects/project/global/ backendServices/backendService
  • compute/v1/projects/project/global/backendServices/backendService
  • global/backendServices/backendService 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 defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified. Only one of defaultService, defaultUrlRedirect or defaultRouteAction. weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:
  • compute.backendBuckets.use
  • compute.backendServices.use Corresponds to the JSON property defaultService

Returns:

  • (String) 


18952
18953
18954
 
# File 'generated/google/apis/compute_beta/classes.rb', line 18952

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:



18957
18958
18959
 
# File 'generated/google/apis/compute_beta/classes.rb', line 18957

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) 


18963
18964
18965
 
# File 'generated/google/apis/compute_beta/classes.rb', line 18963

def description
  @description
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:



18969
18970
18971
 
# File 'generated/google/apis/compute_beta/classes.rb', line 18969

def header_action
  @header_action
end

#name ⇒ String

The name to which this PathMatcher is referred by the HostRule. Corresponds to the JSON property name

Returns:

  • (String) 


18974
18975
18976
 
# File 'generated/google/apis/compute_beta/classes.rb', line 18974

def name
  @name
end

#path_rules ⇒ Array<Google::Apis::ComputeBeta::PathRule>

The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path- first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Only one of pathRules or routeRules must be set. Corresponds to the JSON property pathRules

Returns:



18985
18986
18987
 
# File 'generated/google/apis/compute_beta/classes.rb', line 18985

def path_rules
  @path_rules
end

#route_rules ⇒ Array<Google::Apis::ComputeBeta::HttpRouteRule>

The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Only one of pathRules or routeRules must be set. Corresponds to the JSON property routeRules

Returns:



18994
18995
18996
 
# File 'generated/google/apis/compute_beta/classes.rb', line 18994

def route_rules
  @route_rules
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



19001
19002
19003
19004
19005
19006
19007
19008
19009
19010
 
# File 'generated/google/apis/compute_beta/classes.rb', line 19001

def update!(**args)
  @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)
  @header_action = args[:header_action] if args.key?(:header_action)
  @name = args[:name] if args.key?(:name)
  @path_rules = args[:path_rules] if args.key?(:path_rules)
  @route_rules = args[:route_rules] if args.key?(:route_rules)
end