Class: Google::Apis::NetworkservicesV1::ExtensionChainExtension

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

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.



565
566
567
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 565

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

Instance Attribute Details

#authority ⇒ String

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

Returns:

  • (String) 


509
510
511
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 509

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 or the default setting of FALSE is used, one of the following happens: * 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. Corresponds to the JSON property failOpen

Returns:

  • (Boolean) 


522
523
524
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 522

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


530
531
532
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 530

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) 


539
540
541
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 539

def name
  @name
end

#service ⇒ String

Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, service must be a fully-qualified reference to a backend service in the format: https://www.googleapis.com/compute/v1/projects/project/regions/region/ backendServices/backendServiceor `https://www.googleapis.com/compute/v1/ projects/`project`/global/backendServices/`backendService. Corresponds to the JSON property service

Returns:

  • (String) 


550
551
552
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 550

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 must not be set for the LbRouteExtension resource. Corresponds to the JSON property supportedEvents

Returns:

  • (Array<String>) 


557
558
559
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 557

def supported_events
  @supported_events
end

#timeout ⇒ String

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

Returns:

  • (String) 


563
564
565
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 563

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



570
571
572
573
574
575
576
577
578
 
# File 'lib/google/apis/networkservices_v1/classes.rb', line 570

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