Class: Google::Apis::ComputeV1::PathMatcher

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PathMatcher

Returns a new instance of PathMatcher.



30125
30126
30127
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30125

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

Instance Attribute Details

#default_custom_error_response_policy ⇒ Google::Apis::ComputeV1::CustomErrorResponsePolicy

Specifies the custom error response policy that must be applied when the backend service or backend bucket responds with an error. Corresponds to the JSON property defaultCustomErrorResponsePolicy

Returns:



30050
30051
30052
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30050

def default_custom_error_response_policy
  @default_custom_error_response_policy
end

#default_route_action ⇒ Google::Apis::ComputeV1::HttpRouteAction

defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before 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. If defaultRouteAction is specified, don't set defaultUrlRedirect. If defaultRouteAction.weightedBackendServices is specified, don't set defaultService. URL maps for classic Application Load Balancers only support the urlRewrite action within a path matcher's defaultRouteAction. Corresponds to the JSON property defaultRouteAction

Returns:



30064
30065
30066
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30064

def default_route_action
  @default_route_action
end

#default_service ⇒ String

The full or partial URL to the BackendService resource. This URL is 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 also specified, advanced routing actions, such as URL rewrites, take effect before 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. If defaultService is specified, then set either defaultUrlRedirect or defaultRouteAction.weightedBackendService. Don't set both. 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) 


30083
30084
30085
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30083

def default_service
  @default_service
end

#default_url_redirect ⇒ Google::Apis::ComputeV1::HttpRedirectAction

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

Returns:



30088
30089
30090
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30088

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) 


30094
30095
30096
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30094

def description
  @description
end

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



30100
30101
30102
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30100

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) 


30105
30106
30107
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30105

def name
  @name
end

#path_rules ⇒ Array<Google::Apis::ComputeV1::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. Within a given pathMatcher, only one of pathRules or routeRules must be set. Corresponds to the JSON property pathRules

Returns:



30115
30116
30117
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30115

def path_rules
  @path_rules
end

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

The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules. Corresponds to the JSON property routeRules

Returns:



30123
30124
30125
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30123

def route_rules
  @route_rules
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



30130
30131
30132
30133
30134
30135
30136
30137
30138
30139
30140
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30130

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