Class: Google::Apis::ComputeV1::HttpRouteRule

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

Overview

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

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

Returns a new instance of HttpRouteRule.



8875
8876
8877
 
# File 'generated/google/apis/compute_v1/classes.rb', line 8875

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

Instance Attribute Details

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


8818
8819
8820
 
# File 'generated/google/apis/compute_v1/classes.rb', line 8818

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:



8824
8825
8826
 
# File 'generated/google/apis/compute_v1/classes.rb', line 8824

def header_action
  @header_action
end

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

Corresponds to the JSON property matchRules

Returns:



8829
8830
8831
 
# File 'generated/google/apis/compute_v1/classes.rb', line 8829

def match_rules
  @match_rules
end

#priority ⇒ Fixnum

For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret 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 between 0 and 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) 


8845
8846
8847
 
# File 'generated/google/apis/compute_v1/classes.rb', line 8845

def priority
  @priority
end

#route_action ⇒ Google::Apis::ComputeV1::HttpRouteAction

In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to 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. Corresponds to the JSON property routeAction

Returns:



8856
8857
8858
 
# File 'generated/google/apis/compute_v1/classes.rb', line 8856

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 additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. 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) 


8868
8869
8870
 
# File 'generated/google/apis/compute_v1/classes.rb', line 8868

def service
  @service
end

#url_redirect ⇒ Google::Apis::ComputeV1::HttpRedirectAction

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

Returns:



8873
8874
8875
 
# File 'generated/google/apis/compute_v1/classes.rb', line 8873

def url_redirect
  @url_redirect
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8880
8881
8882
8883
8884
8885
8886
8887
8888
 
# File 'generated/google/apis/compute_v1/classes.rb', line 8880

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