Network Services v1 API - Class ExtensionChain.Types.Extension (1.0.0) 

public sealed class ExtensionChain.Types.Extension : IMessage<ExtensionChain.Types.Extension>, IEquatable<ExtensionChain.Types.Extension>, IDeepCloneable<ExtensionChain.Types.Extension>, IBufferMessage, IMessage

Reference documentation and code samples for the Network Services v1 API class ExtensionChain.Types.Extension.

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

Inheritance

object > ExtensionChain.Types.Extension

Namespace

Google.Cloud.NetworkServices.V1

Assembly

Google.Cloud.NetworkServices.V1.dll

Constructors

Extension()

public Extension()

Extension(Extension)

public Extension(ExtensionChain.Types.Extension other)
Parameter
Name Description
other ExtensionChainTypesExtension

Properties

Authority

public string Authority { get; set; }

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

Property Value
Type Description
string

FailOpen

public bool FailOpen { get; set; }

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.

Property Value
Type Description
bool

ForwardHeaders

public RepeatedField<string> ForwardHeaders { get; }

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.

Property Value
Type Description
RepeatedFieldstring

Name

public string Name { get; set; }

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.

Property Value
Type Description
string

Service

public string Service { get; set; }

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

Property Value
Type Description
string

SupportedEvents

public RepeatedField<EventType> SupportedEvents { get; }

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.

Property Value
Type Description
RepeatedFieldEventType

Timeout

public Duration Timeout { get; set; }

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

Property Value
Type Description
Duration