Class: Google::Apis::ComputeBeta::HttpRouteRule

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_beta/classes.rb,
lib/google/apis/compute_beta/representations.rb,
lib/google/apis/compute_beta/representations.rb

Overview

The HttpRouteRule setting specifies how to match an HTTP request and the corresponding routing action that load balancing proxies perform.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ HttpRouteRule

Returns a new instance of HttpRouteRule.



12712
12713
12714
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12712

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

Instance Attribute Details

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

Returns:



12627
12628
12629
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12627

def custom_error_response_policy
  @custom_error_response_policy
end

#description ⇒ String

The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters. Corresponds to the JSON property description

Returns:

  • (String) 


12633
12634
12635
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12633

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:



12639
12640
12641
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12639

def header_action
  @header_action
end

#http_filter_configs ⇒ Array<Google::Apis::ComputeBeta::HttpFilterConfig>

Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for load balancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. Corresponds to the JSON property httpFilterConfigs

Returns:



12648
12649
12650
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12648

def http_filter_configs
  @http_filter_configs
end

#http_filter_metadata ⇒ Array<Google::Apis::ComputeBeta::HttpFilterConfig>

Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for load balancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details. The only configTypeUrl supported is type. googleapis.com/google.protobuf.Struct Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. Corresponds to the JSON property httpFilterMetadata

Returns:



12658
12659
12660
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12658

def http_filter_metadata
  @http_filter_metadata
end

#match_rules ⇒ Array<Google::Apis::ComputeBeta::HttpRouteRuleMatch>

The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule. Corresponds to the JSON property matchRules

Returns:



12667
12668
12669
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12667

def match_rules
  @match_rules
end

#priority ⇒ Fixnum

For routeRules within a given pathMatcher, priority determines the order in which a load balancer interprets routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied. You cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number from 0 to 2147483647 inclusive. Priority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules. Corresponds to the JSON property priority

Returns:

  • (Fixnum) 


12682
12683
12684
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12682

def priority
  @priority
end

#route_action ⇒ Google::Apis::ComputeBeta::HttpRouteAction

In response to a matching matchRule, the load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. URL maps for Classic external HTTP(S) load balancers only support the urlRewrite action within a route rule's routeAction. Corresponds to the JSON property routeAction

Returns:



12694
12695
12696
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12694

def route_action
  @route_action
end

#service ⇒ String

The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. Corresponds to the JSON property service

Returns:

  • (String) 


12705
12706
12707
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12705

def service
  @service
end

#url_redirect ⇒ Google::Apis::ComputeBeta::HttpRedirectAction

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

Returns:



12710
12711
12712
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12710

def url_redirect
  @url_redirect
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12717

def update!(**args)
  @custom_error_response_policy = args[:custom_error_response_policy] if args.key?(:custom_error_response_policy)
  @description = args[:description] if args.key?(:description)
  @header_action = args[:header_action] if args.key?(:header_action)
  @http_filter_configs = args[:http_filter_configs] if args.key?(:http_filter_configs)
  @http_filter_metadata = args[:http_filter_metadata] if args.key?(:http_filter_metadata)
  @match_rules = args[:match_rules] if args.key?(:match_rules)
  @priority = args[:priority] if args.key?(:priority)
  @route_action = args[:route_action] if args.key?(:route_action)
  @service = args[:service] if args.key?(:service)
  @url_redirect = args[:url_redirect] if args.key?(:url_redirect)
end