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-
(::String) — Optional. The
:authorityheader in the gRPC request sent from Envoy to the extension service. Required for Callout extensions.
#authority=
def authority=(value) -> ::String-
value (::String) — Optional. The
:authorityheader in the gRPC request sent from Envoy to the extension service. Required for Callout extensions.
-
(::String) — Optional. The
:authorityheader in the gRPC request sent from Envoy to the extension service. Required for Callout extensions.
#fail_open
def fail_open() -> ::Boolean-
(::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 toFALSEor the default setting ofFALSEis 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-
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 toFALSEor the default setting ofFALSEis 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.
-
(::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 toFALSEor the default setting ofFALSEis 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>- (::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>- 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.
- (::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- (::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- 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.
- (::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-
(::String) — Required. The reference to the service that runs the extension.
Currently only callout extensions are supported here.
To configure a callout extension,
servicemust be a fully-qualified reference to a backend service in the format:https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}orhttps://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
#service=
def service=(value) -> ::String-
value (::String) — Required. The reference to the service that runs the extension.
Currently only callout extensions are supported here.
To configure a callout extension,
servicemust be a fully-qualified reference to a backend service in the format:https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}orhttps://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
-
(::String) — Required. The reference to the service that runs the extension.
Currently only callout extensions are supported here.
To configure a callout extension,
servicemust be a fully-qualified reference to a backend service in the format:https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}orhttps://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}.
#supported_events
def supported_events() -> ::Array<::Google::Cloud::NetworkServices::V1::EventType>-
(::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
LbTrafficExtensionresource. It's not relevant for theLbRouteExtensionresource.
#supported_events=
def supported_events=(value) -> ::Array<::Google::Cloud::NetworkServices::V1::EventType>-
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
LbTrafficExtensionresource. It's not relevant for theLbRouteExtensionresource.
-
(::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
LbTrafficExtensionresource. It's not relevant for theLbRouteExtensionresource.
#timeout
def timeout() -> ::Google::Protobuf::Duration- (::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- 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.
- (::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.