Interface ExtensionChain.ExtensionOrBuilder (0.4.0)

public static interface ExtensionChain.ExtensionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAuthority()

public abstract String getAuthority()

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

string authority = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The authority.

getAuthorityBytes()

public abstract ByteString getAuthorityBytes()

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

string authority = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for authority.

getFailOpen()

public abstract boolean getFailOpen()

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.

bool fail_open = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The failOpen.

getForwardHeaders(int index)

public abstract String getForwardHeaders(int index)

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.

repeated string forward_headers = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The forwardHeaders at the given index.

getForwardHeadersBytes(int index)

public abstract ByteString getForwardHeadersBytes(int index)

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.

repeated string forward_headers = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the forwardHeaders at the given index.

getForwardHeadersCount()

public abstract int getForwardHeadersCount()

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.

repeated string forward_headers = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of forwardHeaders.

getForwardHeadersList()

public abstract List<String> getForwardHeadersList()

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.

repeated string forward_headers = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`List<String>`	A list containing the forwardHeaders.

getName()

public abstract String getName()

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 name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for name.

getService()

public abstract String getService()

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

string service = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The service.

getServiceBytes()

public abstract ByteString getServiceBytes()

Required. The reference to the service that runs the extension.

Currently only callout extensions are supported here.

string service = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for service.

getSupportedEvents(int index)

public abstract EventType getSupportedEvents(int index)

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.