Class: Google::Apis::ComputeAlpha::HttpRouteRule

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

Constructor Details

#initialize(**args) ⇒ HttpRouteRule

Returns a new instance of HttpRouteRule.



11975
11976
11977
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 11975

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) 


11891
11892
11893
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 11891

def description
  @description
end

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



11897
11898
11899
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 11897

def header_action
  @header_action
end

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

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

Returns:



11907
11908
11909
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 11907

def http_filter_configs
  @http_filter_configs
end

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

Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers 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 target gRPC proxy that has validateForProxyless field set to true. Corresponds to the JSON property httpFilterMetadata

Returns:



11918
11919
11920
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 11918

def http_filter_metadata
  @http_filter_metadata
end

#match_rules ⇒ Array<Google::Apis::ComputeAlpha::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:



11927
11928
11929
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 11927

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) 


11943
11944
11945
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 11943

def priority
  @priority
end

#route_action ⇒ Google::Apis::ComputeAlpha::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

Returns:



11956
11957
11958
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 11956

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) 


11968
11969
11970
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 11968

def service
  @service
end

#url_redirect ⇒ Google::Apis::ComputeAlpha::HttpRedirectAction

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

Returns:



11973
11974
11975
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 11973

def url_redirect
  @url_redirect
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 11980

def update!(**args)
  @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