Reference documentation and code samples for the Google Cloud Network Services V1 Client class Extension.
A single extension in the chain to execute for the matching request.
Generated from protobuf message google.cloud.networkservices.v1.ExtensionChain.Extension
Namespace
Google \ Cloud \ NetworkServices \ V1 \ ExtensionChainMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
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.
↳ authority
string
Optional. The :authority
header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions.
↳ service
string
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}
.
↳ supported_events
array
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.
↳ timeout
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.
↳ fail_open
bool
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
array
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.
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
setName
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.
var
string
$this
getAuthority
Optional. The :authority
header in the gRPC request sent from Envoy
to the extension service.
Required for Callout extensions.
string
setAuthority
Optional. The :authority
header in the gRPC request sent from Envoy
to the extension service.
Required for Callout extensions.
var
string
$this
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
setService
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}
.
var
string
$this
getSupportedEvents
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.
setSupportedEvents
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.
var
int[]
$this
getTimeout
Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions.
hasTimeout
clearTimeout
setTimeout
Optional. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. Required for Callout extensions.
$this
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
setFailOpen
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.
var
bool
$this
getForwardHeaders
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.
setForwardHeaders
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.
var
string[]
$this
