Class: Google::Apis::ComputeV1::HttpRouteRule
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::HttpRouteRule
- 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
-
#description ⇒ String
The short description conveying the intent of this routeRule.
-
#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.
-
#match_rules ⇒ Array<Google::Apis::ComputeV1::HttpRouteRuleMatch>
The list of criteria for matching attributes of a request to this routeRule.
-
#priority ⇒ Fixnum
For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules.
-
#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.
-
#service ⇒ String
The full or partial URL of the backend service resource to which traffic is directed if this rule is matched.
-
#url_redirect ⇒ Google::Apis::ComputeV1::HttpRedirectAction
Specifies settings for an HTTP redirect.
Instance Method Summary collapse
-
#initialize(**args) ⇒ HttpRouteRule
constructor
A new instance of HttpRouteRule.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ HttpRouteRule
Returns a new instance of HttpRouteRule.
9943 9944 9945 |
# File 'generated/google/apis/compute_v1/classes.rb', line 9943 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
9880 9881 9882 |
# File 'generated/google/apis/compute_v1/classes.rb', line 9880 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
9886 9887 9888 |
# File 'generated/google/apis/compute_v1/classes.rb', line 9886 def header_action @header_action end |
#match_rules ⇒ Array<Google::Apis::ComputeV1::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
9895 9896 9897 |
# File 'generated/google/apis/compute_v1/classes.rb', line 9895 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
9911 9912 9913 |
# File 'generated/google/apis/compute_v1/classes.rb', line 9911 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.
UrlMaps for external HTTP(S) load balancers support only the urlRewrite action
within a routeRule's routeAction.
Corresponds to the JSON property routeAction
9924 9925 9926 |
# File 'generated/google/apis/compute_v1/classes.rb', line 9924 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
9936 9937 9938 |
# File 'generated/google/apis/compute_v1/classes.rb', line 9936 def service @service end |
#url_redirect ⇒ Google::Apis::ComputeV1::HttpRedirectAction
Specifies settings for an HTTP redirect.
Corresponds to the JSON property urlRedirect
9941 9942 9943 |
# File 'generated/google/apis/compute_v1/classes.rb', line 9941 def url_redirect @url_redirect end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9948 9949 9950 9951 9952 9953 9954 9955 9956 |
# File 'generated/google/apis/compute_v1/classes.rb', line 9948 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 |