public static final class ExtensionChain.Extension extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ExtensionChain.ExtensionImplements
ExtensionChain.ExtensionOrBuilderStatic Fields
AUTHORITY_FIELD_NUMBER
public static final int AUTHORITY_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
FAIL_OPEN_FIELD_NUMBER
public static final int FAIL_OPEN_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
FORWARD_HEADERS_FIELD_NUMBER
public static final int FORWARD_HEADERS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SERVICE_FIELD_NUMBER
public static final int SERVICE_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
SUPPORTED_EVENTS_FIELD_NUMBER
public static final int SUPPORTED_EVENTS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
TIMEOUT_FIELD_NUMBER
public static final int TIMEOUT_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static ExtensionChain.Extension getDefaultInstance()
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static ExtensionChain.Extension.Builder newBuilder()
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
newBuilder(ExtensionChain.Extension prototype)
public static ExtensionChain.Extension.Builder newBuilder(ExtensionChain.Extension prototype)
Parameter | |
---|---|
Name | Description |
prototype |
ExtensionChain.Extension |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
parseDelimitedFrom(InputStream input)
public static ExtensionChain.Extension parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ExtensionChain.Extension parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static ExtensionChain.Extension parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExtensionChain.Extension parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static ExtensionChain.Extension parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExtensionChain.Extension parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static ExtensionChain.Extension parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ExtensionChain.Extension parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static ExtensionChain.Extension parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ExtensionChain.Extension parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static ExtensionChain.Extension parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExtensionChain.Extension parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<ExtensionChain.Extension> parser()
Returns | |
---|---|
Type | Description |
Parser<Extension> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
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 |
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. |
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. |
getParserForType()
public Parser<ExtensionChain.Extension> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<Extension> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
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. |
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. |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public ExtensionChain.Extension.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExtensionChain.Extension.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public ExtensionChain.Extension.Builder toBuilder()
Returns | |
---|---|
Type | Description |
ExtensionChain.Extension.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |