Network Services V1 API - Class Google::Cloud::NetworkServices::V1::ExtensionChain::Extension (v2.4.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.

    This field is not supported for plugin extensions. Setting it results in a validation error.

#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.

    This field is not supported for plugin extensions. Setting it results in a validation error.

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

    This field is not supported for plugin extensions. Setting it results in a validation error.

#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.

#metadata

def metadata() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) —

    Optional. The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server.

    The metadata is available under the namespace com.google.<extension_type>.<resource_name>.<extension_chain_name>.<extension_name>. For example: com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1.

    The following variables are supported in the metadata:

    {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.

    This field must not be set for plugin extensions. Setting it results in a validation error.

    You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend.

    This field is subject to following limitations:

    • The total size of the metadata must be less than 1KiB.
    • The total number of keys in the metadata must be less than 16.
    • The length of each key must be less than 64 characters.
    • The length of each value must be less than 1024 characters.
    • All values must be strings.

#metadata=

def metadata=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) —

    Optional. The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server.

    The metadata is available under the namespace com.google.<extension_type>.<resource_name>.<extension_chain_name>.<extension_name>. For example: com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1.

    The following variables are supported in the metadata:

    {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.

    This field must not be set for plugin extensions. Setting it results in a validation error.

    You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend.

    This field is subject to following limitations:

    • The total size of the metadata must be less than 1KiB.
    • The total number of keys in the metadata must be less than 16.
    • The length of each key must be less than 64 characters.
    • The length of each value must be less than 1024 characters.
    • All values must be strings.
Returns
  • (::Google::Protobuf::Struct) —

    Optional. The metadata provided here is included as part of the metadata_context (of type google.protobuf.Struct) in the ProcessingRequest message sent to the extension server.

    The metadata is available under the namespace com.google.<extension_type>.<resource_name>.<extension_chain_name>.<extension_name>. For example: com.google.lb_traffic_extension.lbtrafficextension1.chain1.ext1.

    The following variables are supported in the metadata:

    {forwarding_rule_id} - substituted with the forwarding rule's fully qualified resource name.

    This field must not be set for plugin extensions. Setting it results in a validation error.

    You can set metadata at either the resource level or the extension level. The extension level metadata is recommended because you can pass a different set of metadata through each extension to the backend.

    This field is subject to following limitations:

    • The total size of the metadata must be less than 1KiB.
    • The total number of keys in the metadata must be less than 16.
    • The length of each key must be less than 64 characters.
    • The length of each value must be less than 1024 characters.
    • All values must be strings.

#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.

    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}.

    To configure a plugin extension, service must be a reference to a WasmPlugin resource in the format: projects/{project}/locations/{location}/wasmPlugins/{plugin} or //networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}.

    Plugin extensions are currently supported for the LbTrafficExtension, the LbRouteExtension, and the LbEdgeExtension resources.

#service=

def service=(value) -> ::String
Parameter
  • value (::String) — Required. The reference to the service that runs the extension.

    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}.

    To configure a plugin extension, service must be a reference to a WasmPlugin resource in the format: projects/{project}/locations/{location}/wasmPlugins/{plugin} or //networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}.

    Plugin extensions are currently supported for the LbTrafficExtension, the LbRouteExtension, and the LbEdgeExtension resources.

Returns
  • (::String) — Required. The reference to the service that runs the extension.

    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}.

    To configure a plugin extension, service must be a reference to a WasmPlugin resource in the format: projects/{project}/locations/{location}/wasmPlugins/{plugin} or //networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}.

    Plugin extensions are currently supported for the LbTrafficExtension, the LbRouteExtension, and the LbEdgeExtension resources.

#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.

    For the LbTrafficExtension resource, this field is required.

    For the LbRouteExtension resource, this field is optional. If unspecified, REQUEST_HEADERS event is assumed as supported.

    For the LbEdgeExtension resource, this field is required and must only contain REQUEST_HEADERS event.

#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.

    For the LbTrafficExtension resource, this field is required.

    For the LbRouteExtension resource, this field is optional. If unspecified, REQUEST_HEADERS event is assumed as supported.

    For the LbEdgeExtension resource, this field is required and must only contain REQUEST_HEADERS event.

Returns
  • (::Array<::Google::Cloud::NetworkServices::V1::EventType>) — Optional. A set of events during request or response processing for which this extension is called.

    For the LbTrafficExtension resource, this field is required.

    For the LbRouteExtension resource, this field is optional. If unspecified, REQUEST_HEADERS event is assumed as supported.

    For the LbEdgeExtension resource, this field is required and must only contain REQUEST_HEADERS event.

#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-10000 milliseconds. Required for callout extensions.

    This field is not supported for plugin extensions. Setting it results in a validation error.

#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-10000 milliseconds. Required for callout extensions.

    This field is not supported for plugin extensions. Setting it results in a validation error.

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

    This field is not supported for plugin extensions. Setting it results in a validation error.