Class: Google::Apis::NetworkservicesV1::HttpRouteRouteAction

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

Overview

The specifications for routing traffic and applying associated policies.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ HttpRouteRouteAction

Returns a new instance of HttpRouteRouteAction.



1817
1818
1819
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1817

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

Instance Attribute Details

#cors_policy ⇒ Google::Apis::NetworkservicesV1::HttpRouteCorsPolicy

The Specification for allowing client side cross-origin requests. Corresponds to the JSON property corsPolicy

Returns:



1735
1736
1737
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1735

def cors_policy
  @cors_policy
end

#destinations ⇒ Array<Google::Apis::NetworkservicesV1::HttpRouteDestination>

The destination to which traffic should be forwarded. Corresponds to the JSON property destinations

Returns:



1740
1741
1742
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1740

def destinations
  @destinations
end

#direct_response ⇒ Google::Apis::NetworkservicesV1::HttpRouteHttpDirectResponse

Static HTTP response object to be returned. Corresponds to the JSON property directResponse

Returns:



1745
1746
1747
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1745

def direct_response
  @direct_response
end

#fault_injection_policy ⇒ Google::Apis::NetworkservicesV1::HttpRouteFaultInjectionPolicy

The specification for fault injection introduced into traffic to test the resiliency of clients to destination service failure. As part of fault injection, when clients send requests to a destination, delays can be introduced by client proxy on a percentage of requests before sending those requests to the destination service. Similarly requests can be aborted by client proxy for a percentage of requests. Corresponds to the JSON property faultInjectionPolicy

Returns:



1755
1756
1757
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1755

def fault_injection_policy
  @fault_injection_policy
end

#idle_timeout ⇒ String

Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled. Corresponds to the JSON property idleTimeout

Returns:

  • (String) 


1763
1764
1765
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1763

def idle_timeout
  @idle_timeout
end

#redirect ⇒ Google::Apis::NetworkservicesV1::HttpRouteRedirect

The specification for redirecting traffic. Corresponds to the JSON property redirect

Returns:



1768
1769
1770
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1768

def redirect
  @redirect
end

#request_header_modifier ⇒ Google::Apis::NetworkservicesV1::HttpRouteHeaderModifier

The specification for modifying HTTP header in HTTP request and HTTP response. Corresponds to the JSON property requestHeaderModifier

Returns:



1773
1774
1775
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1773

def request_header_modifier
  @request_header_modifier
end

#request_mirror_policy ⇒ Google::Apis::NetworkservicesV1::HttpRouteRequestMirrorPolicy

Specifies the policy on how requests are shadowed to a separate mirrored destination service. The proxy does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow. Corresponds to the JSON property requestMirrorPolicy

Returns:



1781
1782
1783
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1781

def request_mirror_policy
  @request_mirror_policy
end

#response_header_modifier ⇒ Google::Apis::NetworkservicesV1::HttpRouteHeaderModifier

The specification for modifying HTTP header in HTTP request and HTTP response. Corresponds to the JSON property responseHeaderModifier

Returns:



1786
1787
1788
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1786

def response_header_modifier
  @response_header_modifier
end

#retry_policy ⇒ Google::Apis::NetworkservicesV1::HttpRouteRetryPolicy

The specifications for retries. Corresponds to the JSON property retryPolicy

Returns:



1791
1792
1793
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1791

def retry_policy
  @retry_policy
end

#stateful_session_affinity ⇒ Google::Apis::NetworkservicesV1::HttpRouteStatefulSessionAffinityPolicy

The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name "GSSA" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy. The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next. Corresponds to the JSON property statefulSessionAffinity

Returns:



1802
1803
1804
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1802

def stateful_session_affinity
  @stateful_session_affinity
end

#timeout ⇒ String

Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries. Corresponds to the JSON property timeout

Returns:

  • (String) 


1809
1810
1811
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1809

def timeout
  @timeout
end

#url_rewrite ⇒ Google::Apis::NetworkservicesV1::HttpRouteUrlRewrite

The specification for modifying the URL of the request, prior to forwarding the request to the destination. Corresponds to the JSON property urlRewrite

Returns:



1815
1816
1817
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1815

def url_rewrite
  @url_rewrite
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 1822

def update!(**args)
  @cors_policy = args[:cors_policy] if args.key?(:cors_policy)
  @destinations = args[:destinations] if args.key?(:destinations)
  @direct_response = args[:direct_response] if args.key?(:direct_response)
  @fault_injection_policy = args[:fault_injection_policy] if args.key?(:fault_injection_policy)
  @idle_timeout = args[:idle_timeout] if args.key?(:idle_timeout)
  @redirect = args[:redirect] if args.key?(:redirect)
  @request_header_modifier = args[:request_header_modifier] if args.key?(:request_header_modifier)
  @request_mirror_policy = args[:request_mirror_policy] if args.key?(:request_mirror_policy)
  @response_header_modifier = args[:response_header_modifier] if args.key?(:response_header_modifier)
  @retry_policy = args[:retry_policy] if args.key?(:retry_policy)
  @stateful_session_affinity = args[:stateful_session_affinity] if args.key?(:stateful_session_affinity)
  @timeout = args[:timeout] if args.key?(:timeout)
  @url_rewrite = args[:url_rewrite] if args.key?(:url_rewrite)
end