public static final class ExtensionChain.Extension.Builder extends GeneratedMessageV3.Builder<ExtensionChain.Extension.Builder> implements ExtensionChain.ExtensionOrBuilder
A single extension in the chain to execute for the matching request.
Protobuf type google.cloud.networkservices.v1.ExtensionChain.Extension
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ExtensionChain.Extension.BuilderImplements
ExtensionChain.ExtensionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllForwardHeaders(Iterable<String> values)
public ExtensionChain.Extension.Builder addAllForwardHeaders(Iterable<String> values)
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 |
values |
Iterable<String> The forwardHeaders to add. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
addAllSupportedEvents(Iterable<? extends EventType> values)
public ExtensionChain.Extension.Builder addAllSupportedEvents(Iterable<? extends EventType> values)
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.
repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.cloud.networkservices.v1.EventType> The supportedEvents to add. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
addAllSupportedEventsValue(Iterable<Integer> values)
public ExtensionChain.Extension.Builder addAllSupportedEventsValue(Iterable<Integer> values)
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.
repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Iterable<Integer> The enum numeric values on the wire for supportedEvents to add. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
addForwardHeaders(String value)
public ExtensionChain.Extension.Builder addForwardHeaders(String value)
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 |
value |
String The forwardHeaders to add. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
addForwardHeadersBytes(ByteString value)
public ExtensionChain.Extension.Builder addForwardHeadersBytes(ByteString value)
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 |
value |
ByteString The bytes of the forwardHeaders to add. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ExtensionChain.Extension.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
addSupportedEvents(EventType value)
public ExtensionChain.Extension.Builder addSupportedEvents(EventType value)
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.
repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
EventType The supportedEvents to add. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
addSupportedEventsValue(int value)
public ExtensionChain.Extension.Builder addSupportedEventsValue(int value)
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.
repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for supportedEvents to add. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
build()
public ExtensionChain.Extension build()
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
buildPartial()
public ExtensionChain.Extension buildPartial()
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
clear()
public ExtensionChain.Extension.Builder clear()
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
clearAuthority()
public ExtensionChain.Extension.Builder clearAuthority()
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.
string authority = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
clearFailOpen()
public ExtensionChain.Extension.Builder clearFailOpen()
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 |
ExtensionChain.Extension.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ExtensionChain.Extension.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
clearForwardHeaders()
public ExtensionChain.Extension.Builder clearForwardHeaders()
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 |
ExtensionChain.Extension.Builder |
This builder for chaining. |
clearMetadata()
public ExtensionChain.Extension.Builder clearMetadata()
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.
.google.protobuf.Struct metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
clearName()
public ExtensionChain.Extension.Builder clearName()
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 |
ExtensionChain.Extension.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ExtensionChain.Extension.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
clearService()
public ExtensionChain.Extension.Builder clearService()
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.
string service = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
clearSupportedEvents()
public ExtensionChain.Extension.Builder clearSupportedEvents()
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.
repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
clearTimeout()
public ExtensionChain.Extension.Builder clearTimeout()
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.
.google.protobuf.Duration timeout = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
clone()
public ExtensionChain.Extension.Builder clone()
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
getAuthority()
public String getAuthority()
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.
string authority = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The authority. |
getAuthorityBytes()
public ByteString getAuthorityBytes()
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.
string authority = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for authority. |
getDefaultInstanceForType()
public ExtensionChain.Extension getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getFailOpen()
public 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 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 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 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 ProtocolStringList 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 |
ProtocolStringList |
A list containing the forwardHeaders. |
getMetadata()
public Struct getMetadata()
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.
.google.protobuf.Struct metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Struct |
The metadata. |
getMetadataBuilder()
public Struct.Builder getMetadataBuilder()
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.
.google.protobuf.Struct metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Builder |
getMetadataOrBuilder()
public StructOrBuilder getMetadataOrBuilder()
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.
.google.protobuf.Struct metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
StructOrBuilder |
getName()
public 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 ByteString getNameBytes()
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 |
ByteString |
The bytes for name. |
getService()
public String getService()
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.
string service = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String |
The service. |
getServiceBytes()
public ByteString getServiceBytes()
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.
string service = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for service. |
getSupportedEvents(int index)
public EventType getSupportedEvents(int index)
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.
repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
EventType |
The supportedEvents at the given index. |
getSupportedEventsCount()
public int getSupportedEventsCount()
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.
repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The count of supportedEvents. |
getSupportedEventsList()
public List<EventType> getSupportedEventsList()
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.
repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<EventType> |
A list containing the supportedEvents. |
getSupportedEventsValue(int index)
public int getSupportedEventsValue(int index)
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.
repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index |
int The index of the value to return. |
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire of supportedEvents at the given index. |
getSupportedEventsValueList()
public List<Integer> getSupportedEventsValueList()
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.
repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for supportedEvents. |
getTimeout()
public Duration getTimeout()
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.
.google.protobuf.Duration timeout = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Duration |
The timeout. |
getTimeoutBuilder()
public Duration.Builder getTimeoutBuilder()
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.
.google.protobuf.Duration timeout = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Builder |
getTimeoutOrBuilder()
public DurationOrBuilder getTimeoutOrBuilder()
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.
.google.protobuf.Duration timeout = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
DurationOrBuilder |
hasMetadata()
public boolean hasMetadata()
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.
.google.protobuf.Struct metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the metadata field is set. |
hasTimeout()
public boolean hasTimeout()
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.
.google.protobuf.Duration timeout = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the timeout field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ExtensionChain.Extension other)
public ExtensionChain.Extension.Builder mergeFrom(ExtensionChain.Extension other)
Parameter | |
---|---|
Name | Description |
other |
ExtensionChain.Extension |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ExtensionChain.Extension.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ExtensionChain.Extension.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
mergeMetadata(Struct value)
public ExtensionChain.Extension.Builder mergeMetadata(Struct value)
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.
.google.protobuf.Struct metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Struct |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
mergeTimeout(Duration value)
public ExtensionChain.Extension.Builder mergeTimeout(Duration value)
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.
.google.protobuf.Duration timeout = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ExtensionChain.Extension.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
setAuthority(String value)
public ExtensionChain.Extension.Builder setAuthority(String value)
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.
string authority = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The authority to set. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
setAuthorityBytes(ByteString value)
public ExtensionChain.Extension.Builder setAuthorityBytes(ByteString value)
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.
string authority = 2 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for authority to set. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
setFailOpen(boolean value)
public ExtensionChain.Extension.Builder setFailOpen(boolean value)
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];
Parameter | |
---|---|
Name | Description |
value |
boolean The failOpen to set. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ExtensionChain.Extension.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
setForwardHeaders(int index, String value)
public ExtensionChain.Extension.Builder setForwardHeaders(int index, String value)
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];
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The forwardHeaders to set. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
setMetadata(Struct value)
public ExtensionChain.Extension.Builder setMetadata(Struct value)
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.
.google.protobuf.Struct metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Struct |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
setMetadata(Struct.Builder builderForValue)
public ExtensionChain.Extension.Builder setMetadata(Struct.Builder builderForValue)
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.
.google.protobuf.Struct metadata = 9 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
setName(String value)
public ExtensionChain.Extension.Builder setName(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public ExtensionChain.Extension.Builder setNameBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ExtensionChain.Extension.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
setService(String value)
public ExtensionChain.Extension.Builder setService(String value)
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.
string service = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The service to set. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
setServiceBytes(ByteString value)
public ExtensionChain.Extension.Builder setServiceBytes(ByteString value)
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.
string service = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for service to set. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
setSupportedEvents(int index, EventType value)
public ExtensionChain.Extension.Builder setSupportedEvents(int index, EventType value)
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.
repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
EventType The supportedEvents to set. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
setSupportedEventsValue(int index, int value)
public ExtensionChain.Extension.Builder setSupportedEventsValue(int index, int value)
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.
repeated .google.cloud.networkservices.v1.EventType supported_events = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
int The enum numeric value on the wire for supportedEvents to set. |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
This builder for chaining. |
setTimeout(Duration value)
public ExtensionChain.Extension.Builder setTimeout(Duration value)
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.
.google.protobuf.Duration timeout = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
setTimeout(Duration.Builder builderForValue)
public ExtensionChain.Extension.Builder setTimeout(Duration.Builder builderForValue)
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.
.google.protobuf.Duration timeout = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ExtensionChain.Extension.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |