Network Services V1 API - Class Google::Cloud::NetworkServices::V1::ExtensionChain::Extension (v0.2.0)

Version 0.2.0

• 1.0.1 (latest)
• 1.0.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Network Services V1 API class Google::Cloud::NetworkServices::V1::ExtensionChain::Extension.

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

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#authority

def authority() -> ::String

Returns

• (::String) — Optional. The :authority header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions.

#authority=

def authority=(value) -> ::String

Parameter

• value (::String) — Optional. The :authority header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions.

Returns

• (::String) — Optional. The :authority header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions.

#fail_open

def fail_open() -> ::Boolean

Returns

• (::Boolean) —

  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.

#fail_open=

def fail_open=(value) -> ::Boolean

Parameter

• value (::Boolean) —

  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.

Returns

• (::Boolean) —

  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.

#forward_headers

def forward_headers() -> ::Array<::String>

Returns

• (::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.

#forward_headers=

def forward_headers=(value) -> ::Array<::String>

Parameter

• value (::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.

Returns

• (::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.

#name

def name() -> ::String

Returns

• (::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.

#name=

def name=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#service

def service() -> ::String

Returns

• (::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/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.

#service=

def service=(value) -> ::String

Parameter

• value (::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/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.

Returns

• (::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/{backendService} or https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.

#supported_events

def supported_events() -> ::Array<::Google::Cloud::NetworkServices::V1::EventType>

Returns

• (::Array<::Google::Cloud::NetworkServices::V1::EventType>) — 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.

#supported_events=

def supported_events=(value) -> ::Array<::Google::Cloud::NetworkServices::V1::EventType>

Parameter

• value (::Array<::Google::Cloud::NetworkServices::V1::EventType>) — 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.

Returns

• (::Array<::Google::Cloud::NetworkServices::V1::EventType>) — 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.

#timeout

def timeout() -> ::Google::Protobuf::Duration

Returns

• (::Google::Protobuf::Duration) — Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions.

#timeout=

def timeout=(value) -> ::Google::Protobuf::Duration

Parameter

• value (::Google::Protobuf::Duration) — Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions.

Returns

• (::Google::Protobuf::Duration) — Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions.