Class ExtensionChainExtension

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

Inheritance
object
ExtensionChainExtension
Implements
Inherited Members
Namespace: Google.Apis.NetworkServices.v1beta1.Data
Assembly: Google.Apis.NetworkServices.v1beta1.dll
Syntax
public class ExtensionChainExtension : IDirectResponseSchema

Properties

AllowDynamicForwarding

Optional. When set to TRUE, the response from an extension service is allowed to set the com.google.envoy.dynamic_forwarding namespace in the dynamic metadata. This field is not supported for plugin extensions. Setting it results in a validation error.

Declaration
[JsonProperty("allowDynamicForwarding")]
public virtual bool? AllowDynamicForwarding { get; set; }
Property Value
Type Description
bool?

Authority

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.

Declaration
[JsonProperty("authority")]
public virtual string Authority { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FailOpen

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.

Declaration
[JsonProperty("failOpen")]
public virtual bool? FailOpen { get; set; }
Property Value
Type Description
bool?

ForwardHeaders

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.

Declaration
[JsonProperty("forwardHeaders")]
public virtual IList<string> ForwardHeaders { get; set; }
Property Value
Type Description
IList<string>

Metadata

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

Declaration
[JsonProperty("metadata")]
public virtual IDictionary<string, object> Metadata { get; set; }
Property Value
Type Description
IDictionary<string, object>

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

RequestBodySendMode

Optional. Configures the send mode for request body processing. The field can only be set if supported_events includes REQUEST_BODY. If supported_events includes REQUEST_BODY, but request_body_send_mode is unset, the default value STREAMED is used. When this field is set to FULL_DUPLEX_STREAMED, supported_events must include both REQUEST_BODY and REQUEST_TRAILERS. This field can be set only for LbTrafficExtension and LbRouteExtension resources, and only when the service field of the extension points to a BackendService. Only FULL_DUPLEX_STREAMED mode is supported for LbRouteExtension resources.

Declaration
[JsonProperty("requestBodySendMode")]
public virtual string RequestBodySendMode { get; set; }
Property Value
Type Description
string

ResponseBodySendMode

Optional. Configures the send mode for response processing. If unspecified, the default value STREAMED is used. When this field is set to FULL_DUPLEX_STREAMED, supported_events must include both RESPONSE_BODY and RESPONSE_TRAILERS. This field can be set only for LbTrafficExtension resources, and only when the service field of the extension points to a BackendService.

Declaration
[JsonProperty("responseBodySendMode")]
public virtual string ResponseBodySendMode { get; set; }
Property Value
Type Description
string

Service

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 and the LbRouteExtension resources.

Declaration
[JsonProperty("service")]
public virtual string Service { get; set; }
Property Value
Type Description
string

SupportedEvents

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 is optional for the LbRouteExtension resource. If unspecified REQUEST_HEADERS event is assumed as supported.

Declaration
[JsonProperty("supportedEvents")]
public virtual IList<string> SupportedEvents { get; set; }
Property Value
Type Description
IList<string>

Timeout

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.

Declaration
[JsonProperty("timeout")]
public virtual object Timeout { get; set; }
Property Value
Type Description
object

Implements