public static final class AuthzExtension.Builder extends GeneratedMessageV3.Builder<AuthzExtension.Builder> implements AuthzExtensionOrBuilder
AuthzExtension
is a resource that allows traffic forwarding
to a callout backend service to make an authorization decision.
Protobuf type google.cloud.networkservices.v1.AuthzExtension
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AuthzExtension.BuilderImplements
AuthzExtensionOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllForwardHeaders(Iterable<String> values)
public AuthzExtension.Builder addAllForwardHeaders(Iterable<String> values)
Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
repeated string forward_headers = 12 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Iterable<String> The forwardHeaders to add. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
addForwardHeaders(String value)
public AuthzExtension.Builder addForwardHeaders(String value)
Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
repeated string forward_headers = 12 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The forwardHeaders to add. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
addForwardHeadersBytes(ByteString value)
public AuthzExtension.Builder addForwardHeadersBytes(ByteString value)
Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
repeated string forward_headers = 12 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes of the forwardHeaders to add. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AuthzExtension.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
build()
public AuthzExtension build()
Returns | |
---|---|
Type | Description |
AuthzExtension |
buildPartial()
public AuthzExtension buildPartial()
Returns | |
---|---|
Type | Description |
AuthzExtension |
clear()
public AuthzExtension.Builder clear()
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
clearAuthority()
public AuthzExtension.Builder clearAuthority()
Required. The :authority
header in the gRPC request sent from Envoy
to the extension service.
string authority = 7 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
clearCreateTime()
public AuthzExtension.Builder clearCreateTime()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
clearDescription()
public AuthzExtension.Builder clearDescription()
Optional. A human-readable description of the resource.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
clearFailOpen()
public AuthzExtension.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 = 10 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public AuthzExtension.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
clearForwardHeaders()
public AuthzExtension.Builder clearForwardHeaders()
Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
repeated string forward_headers = 12 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
clearLabels()
public AuthzExtension.Builder clearLabels()
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
clearLoadBalancingScheme()
public AuthzExtension.Builder clearLoadBalancingScheme()
Required. All backend services and forwarding rules referenced by this
extension must share the same load balancing scheme. Supported values:
INTERNAL_MANAGED
, EXTERNAL_MANAGED
. For more information, refer to
Backend services
overview.
.google.cloud.networkservices.v1.LoadBalancingScheme load_balancing_scheme = 6 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
clearMetadata()
public AuthzExtension.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.authz_extension.<resource_name>
.
The following variables are supported in the metadata Struct:
{forwarding_rule_id}
- substituted with the forwarding rule's fully
qualified resource name.
.google.protobuf.Struct metadata = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
clearName()
public AuthzExtension.Builder clearName()
Required. Identifier. Name of the AuthzExtension
resource in the
following format:
projects/{project}/locations/{location}/authzExtensions/{authz_extension}
.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public AuthzExtension.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
clearService()
public AuthzExtension.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}
.
string service = 8 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
clearTimeout()
public AuthzExtension.Builder clearTimeout()
Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
.google.protobuf.Duration timeout = 9 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
clearUpdateTime()
public AuthzExtension.Builder clearUpdateTime()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
clearWireFormat()
public AuthzExtension.Builder clearWireFormat()
Optional. The format of communication supported by the callout extension.
If not specified, the default value EXT_PROC_GRPC
is used.
.google.cloud.networkservices.v1.WireFormat wire_format = 14 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
clone()
public AuthzExtension.Builder clone()
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
containsLabels(String key)
public boolean containsLabels(String key)
Optional. Set of labels associated with the AuthzExtension
resource.
The format must comply with the requirements for labels for Google Cloud resources.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
boolean |
getAuthority()
public String getAuthority()
Required. The :authority
header in the gRPC request sent from Envoy
to the extension service.
string authority = 7 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
String |
The authority. |
getAuthorityBytes()
public ByteString getAuthorityBytes()
Required. The :authority
header in the gRPC request sent from Envoy
to the extension service.
string authority = 7 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for authority. |
getCreateTime()
public Timestamp getCreateTime()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDefaultInstanceForType()
public AuthzExtension getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
AuthzExtension |
getDescription()
public String getDescription()
Optional. A human-readable description of the resource.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. A human-readable description of the resource.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for description. |
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 = 10 [(.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). If omitted, all headers are sent. Each element is a string indicating the header name.
repeated string forward_headers = 12 [(.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). If omitted, all headers are sent. Each element is a string indicating the header name.
repeated string forward_headers = 12 [(.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). If omitted, all headers are sent. Each element is a string indicating the header name.
repeated string forward_headers = 12 [(.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). If omitted, all headers are sent. Each element is a string indicating the header name.
repeated string forward_headers = 12 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the forwardHeaders. |
getLabels() (deprecated)
public Map<String,String> getLabels()
Use #getLabelsMap() instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsCount()
public int getLabelsCount()
Optional. Set of labels associated with the AuthzExtension
resource.
The format must comply with the requirements for labels for Google Cloud resources.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. Set of labels associated with the AuthzExtension
resource.
The format must comply with the requirements for labels for Google Cloud resources.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
Map<String,String> |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. Set of labels associated with the AuthzExtension
resource.
The format must comply with the requirements for labels for Google Cloud resources.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
key |
String |
defaultValue |
String |
Returns | |
---|---|
Type | Description |
String |
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. Set of labels associated with the AuthzExtension
resource.
The format must comply with the requirements for labels for Google Cloud resources.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
String |
getLoadBalancingScheme()
public LoadBalancingScheme getLoadBalancingScheme()
Required. All backend services and forwarding rules referenced by this
extension must share the same load balancing scheme. Supported values:
INTERNAL_MANAGED
, EXTERNAL_MANAGED
. For more information, refer to
Backend services
overview.
.google.cloud.networkservices.v1.LoadBalancingScheme load_balancing_scheme = 6 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
LoadBalancingScheme |
The loadBalancingScheme. |
getLoadBalancingSchemeValue()
public int getLoadBalancingSchemeValue()
Required. All backend services and forwarding rules referenced by this
extension must share the same load balancing scheme. Supported values:
INTERNAL_MANAGED
, EXTERNAL_MANAGED
. For more information, refer to
Backend services
overview.
.google.cloud.networkservices.v1.LoadBalancingScheme load_balancing_scheme = 6 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for loadBalancingScheme. |
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.authz_extension.<resource_name>
.
The following variables are supported in the metadata Struct:
{forwarding_rule_id}
- substituted with the forwarding rule's fully
qualified resource name.
.google.protobuf.Struct metadata = 11 [(.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.authz_extension.<resource_name>
.
The following variables are supported in the metadata Struct:
{forwarding_rule_id}
- substituted with the forwarding rule's fully
qualified resource name.
.google.protobuf.Struct metadata = 11 [(.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.authz_extension.<resource_name>
.
The following variables are supported in the metadata Struct:
{forwarding_rule_id}
- substituted with the forwarding rule's fully
qualified resource name.
.google.protobuf.Struct metadata = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
StructOrBuilder |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()
Use alternate mutation accessors instead.
Returns | |
---|---|
Type | Description |
Map<String,String> |
getName()
public String getName()
Required. Identifier. Name of the AuthzExtension
resource in the
following format:
projects/{project}/locations/{location}/authzExtensions/{authz_extension}
.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()
Required. Identifier. Name of the AuthzExtension
resource in the
following format:
projects/{project}/locations/{location}/authzExtensions/{authz_extension}
.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];
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}
.
string service = 8 [(.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}
.
string service = 8 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for service. |
getTimeout()
public Duration getTimeout()
Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
.google.protobuf.Duration timeout = 9 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Duration |
The timeout. |
getTimeoutBuilder()
public Duration.Builder getTimeoutBuilder()
Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
.google.protobuf.Duration timeout = 9 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
Builder |
getTimeoutOrBuilder()
public DurationOrBuilder getTimeoutOrBuilder()
Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
.google.protobuf.Duration timeout = 9 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
DurationOrBuilder |
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getWireFormat()
public WireFormat getWireFormat()
Optional. The format of communication supported by the callout extension.
If not specified, the default value EXT_PROC_GRPC
is used.
.google.cloud.networkservices.v1.WireFormat wire_format = 14 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
WireFormat |
The wireFormat. |
getWireFormatValue()
public int getWireFormatValue()
Optional. The format of communication supported by the callout extension.
If not specified, the default value EXT_PROC_GRPC
is used.
.google.cloud.networkservices.v1.WireFormat wire_format = 14 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for wireFormat. |
hasCreateTime()
public boolean hasCreateTime()
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the createTime field is set. |
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.authz_extension.<resource_name>
.
The following variables are supported in the metadata Struct:
{forwarding_rule_id}
- substituted with the forwarding rule's fully
qualified resource name.
.google.protobuf.Struct metadata = 11 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
boolean |
Whether the metadata field is set. |
hasTimeout()
public boolean hasTimeout()
Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
.google.protobuf.Duration timeout = 9 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
boolean |
Whether the timeout field is set. |
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the updateTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter | |
---|---|
Name | Description |
number |
int |
Returns | |
---|---|
Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeCreateTime(Timestamp value)
public AuthzExtension.Builder mergeCreateTime(Timestamp value)
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
mergeFrom(AuthzExtension other)
public AuthzExtension.Builder mergeFrom(AuthzExtension other)
Parameter | |
---|---|
Name | Description |
other |
AuthzExtension |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AuthzExtension.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public AuthzExtension.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
mergeMetadata(Struct value)
public AuthzExtension.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.authz_extension.<resource_name>
.
The following variables are supported in the metadata Struct:
{forwarding_rule_id}
- substituted with the forwarding rule's fully
qualified resource name.
.google.protobuf.Struct metadata = 11 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Struct |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
mergeTimeout(Duration value)
public AuthzExtension.Builder mergeTimeout(Duration value)
Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
.google.protobuf.Duration timeout = 9 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AuthzExtension.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
mergeUpdateTime(Timestamp value)
public AuthzExtension.Builder mergeUpdateTime(Timestamp value)
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
putAllLabels(Map<String,String> values)
public AuthzExtension.Builder putAllLabels(Map<String,String> values)
Optional. Set of labels associated with the AuthzExtension
resource.
The format must comply with the requirements for labels for Google Cloud resources.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values |
Map<String,String> |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
putLabels(String key, String value)
public AuthzExtension.Builder putLabels(String key, String value)
Optional. Set of labels associated with the AuthzExtension
resource.
The format must comply with the requirements for labels for Google Cloud resources.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
key |
String |
value |
String |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
removeLabels(String key)
public AuthzExtension.Builder removeLabels(String key)
Optional. Set of labels associated with the AuthzExtension
resource.
The format must comply with the requirements for labels for Google Cloud resources.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
key |
String |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
setAuthority(String value)
public AuthzExtension.Builder setAuthority(String value)
Required. The :authority
header in the gRPC request sent from Envoy
to the extension service.
string authority = 7 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The authority to set. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
setAuthorityBytes(ByteString value)
public AuthzExtension.Builder setAuthorityBytes(ByteString value)
Required. The :authority
header in the gRPC request sent from Envoy
to the extension service.
string authority = 7 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for authority to set. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
setCreateTime(Timestamp value)
public AuthzExtension.Builder setCreateTime(Timestamp value)
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public AuthzExtension.Builder setCreateTime(Timestamp.Builder builderForValue)
Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
setDescription(String value)
public AuthzExtension.Builder setDescription(String value)
Optional. A human-readable description of the resource.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
String The description to set. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public AuthzExtension.Builder setDescriptionBytes(ByteString value)
Optional. A human-readable description of the resource.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for description to set. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
setFailOpen(boolean value)
public AuthzExtension.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 = 10 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
boolean The failOpen to set. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public AuthzExtension.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
setForwardHeaders(int index, String value)
public AuthzExtension.Builder setForwardHeaders(int index, String value)
Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.
repeated string forward_headers = 12 [(.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 |
AuthzExtension.Builder |
This builder for chaining. |
setLoadBalancingScheme(LoadBalancingScheme value)
public AuthzExtension.Builder setLoadBalancingScheme(LoadBalancingScheme value)
Required. All backend services and forwarding rules referenced by this
extension must share the same load balancing scheme. Supported values:
INTERNAL_MANAGED
, EXTERNAL_MANAGED
. For more information, refer to
Backend services
overview.
.google.cloud.networkservices.v1.LoadBalancingScheme load_balancing_scheme = 6 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
LoadBalancingScheme The loadBalancingScheme to set. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
setLoadBalancingSchemeValue(int value)
public AuthzExtension.Builder setLoadBalancingSchemeValue(int value)
Required. All backend services and forwarding rules referenced by this
extension must share the same load balancing scheme. Supported values:
INTERNAL_MANAGED
, EXTERNAL_MANAGED
. For more information, refer to
Backend services
overview.
.google.cloud.networkservices.v1.LoadBalancingScheme load_balancing_scheme = 6 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for loadBalancingScheme to set. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
setMetadata(Struct value)
public AuthzExtension.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.authz_extension.<resource_name>
.
The following variables are supported in the metadata Struct:
{forwarding_rule_id}
- substituted with the forwarding rule's fully
qualified resource name.
.google.protobuf.Struct metadata = 11 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
Struct |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
setMetadata(Struct.Builder builderForValue)
public AuthzExtension.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.authz_extension.<resource_name>
.
The following variables are supported in the metadata Struct:
{forwarding_rule_id}
- substituted with the forwarding rule's fully
qualified resource name.
.google.protobuf.Struct metadata = 11 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
setName(String value)
public AuthzExtension.Builder setName(String value)
Required. Identifier. Name of the AuthzExtension
resource in the
following format:
projects/{project}/locations/{location}/authzExtensions/{authz_extension}
.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public AuthzExtension.Builder setNameBytes(ByteString value)
Required. Identifier. Name of the AuthzExtension
resource in the
following format:
projects/{project}/locations/{location}/authzExtensions/{authz_extension}
.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IDENTIFIER];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AuthzExtension.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
setService(String value)
public AuthzExtension.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}
.
string service = 8 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
String The service to set. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
setServiceBytes(ByteString value)
public AuthzExtension.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}
.
string service = 8 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for service to set. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
setTimeout(Duration value)
public AuthzExtension.Builder setTimeout(Duration value)
Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
.google.protobuf.Duration timeout = 9 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
value |
Duration |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
setTimeout(Duration.Builder builderForValue)
public AuthzExtension.Builder setTimeout(Duration.Builder builderForValue)
Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.
.google.protobuf.Duration timeout = 9 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final AuthzExtension.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
setUpdateTime(Timestamp value)
public AuthzExtension.Builder setUpdateTime(Timestamp value)
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
setUpdateTime(Timestamp.Builder builderForValue)
public AuthzExtension.Builder setUpdateTime(Timestamp.Builder builderForValue)
Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
setWireFormat(WireFormat value)
public AuthzExtension.Builder setWireFormat(WireFormat value)
Optional. The format of communication supported by the callout extension.
If not specified, the default value EXT_PROC_GRPC
is used.
.google.cloud.networkservices.v1.WireFormat wire_format = 14 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
WireFormat The wireFormat to set. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |
setWireFormatValue(int value)
public AuthzExtension.Builder setWireFormatValue(int value)
Optional. The format of communication supported by the callout extension.
If not specified, the default value EXT_PROC_GRPC
is used.
.google.cloud.networkservices.v1.WireFormat wire_format = 14 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for wireFormat to set. |
Returns | |
---|---|
Type | Description |
AuthzExtension.Builder |
This builder for chaining. |