Class: Google::Apis::NetworkservicesV1beta1::ExtensionChainExtension

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

Overview

A single extension in the chain to execute for the matching request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ExtensionChainExtension

Returns a new instance of ExtensionChainExtension.



470
471
472
 
# File 'lib/google/apis/networkservices_v1beta1/classes.rb', line 470

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

Instance Attribute Details

#authority ⇒ String

Required. The :authority header in the gRPC request sent from Envoy to the extension service. Corresponds to the JSON property authority

Returns:

  • (String) 


419
420
421
 
# File 'lib/google/apis/networkservices_v1beta1/classes.rb', line 419

def authority
  @authority
end

#fail_open ⇒ Boolean Also known as: fail_open?

Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to TRUE, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to FALSE: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. Default is FALSE. Corresponds to the JSON property failOpen

Returns:

  • (Boolean) 


431
432
433
 
# File 'lib/google/apis/networkservices_v1beta1/classes.rb', line 431

def fail_open
  @fail_open
end

#forward_headers ⇒ Array<String>

Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. Corresponds to the JSON property forwardHeaders

Returns:

  • (Array<String>) 


439
440
441
 
# File 'lib/google/apis/networkservices_v1beta1/classes.rb', line 439

def forward_headers
  @forward_headers
end

#name ⇒ String

Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower- cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. Corresponds to the JSON property name

Returns:

  • (String) 


448
449
450
 
# File 'lib/google/apis/networkservices_v1beta1/classes.rb', line 448

def name
  @name
end

#service ⇒ String

Required. The reference to the service that runs the extension. Must be a reference to a backend service. Corresponds to the JSON property service

Returns:

  • (String) 


455
456
457
 
# File 'lib/google/apis/networkservices_v1beta1/classes.rb', line 455

def service
  @service
end

#supported_events ⇒ Array<String>

Optional. A set of events during request or response processing for which this extension is called. This field is required for the LbTrafficExtension resource. It's not relevant for the LbRouteExtension resource. Corresponds to the JSON property supportedEvents

Returns:

  • (Array<String>) 


462
463
464
 
# File 'lib/google/apis/networkservices_v1beta1/classes.rb', line 462

def supported_events
  @supported_events
end

#timeout ⇒ String

Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Corresponds to the JSON property timeout

Returns:

  • (String) 


468
469
470
 
# File 'lib/google/apis/networkservices_v1beta1/classes.rb', line 468

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



475
476
477
478
479
480
481
482
483
 
# File 'lib/google/apis/networkservices_v1beta1/classes.rb', line 475

def update!(**args)
  @authority = args[:authority] if args.key?(:authority)
  @fail_open = args[:fail_open] if args.key?(:fail_open)
  @forward_headers = args[:forward_headers] if args.key?(:forward_headers)
  @name = args[:name] if args.key?(:name)
  @service = args[:service] if args.key?(:service)
  @supported_events = args[:supported_events] if args.key?(:supported_events)
  @timeout = args[:timeout] if args.key?(:timeout)
end