public final class AuthzExtension extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
AUTHORITY_FIELD_NUMBER
public static final int AUTHORITY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FAIL_OPEN_FIELD_NUMBER
public static final int FAIL_OPEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FORWARD_HEADERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LOAD_BALANCING_SCHEME_FIELD_NUMBER
public static final int LOAD_BALANCING_SCHEME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
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 |
|
TIMEOUT_FIELD_NUMBER
public static final int TIMEOUT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int WIRE_FORMAT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static AuthzExtension getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AuthzExtension.Builder newBuilder()
newBuilder(AuthzExtension prototype)
public static AuthzExtension.Builder newBuilder(AuthzExtension prototype)
public static AuthzExtension parseDelimitedFrom(InputStream input)
public static AuthzExtension parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AuthzExtension parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AuthzExtension parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AuthzExtension parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AuthzExtension parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AuthzExtension parseFrom(CodedInputStream input)
public static AuthzExtension parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AuthzExtension parseFrom(InputStream input)
public static AuthzExtension parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AuthzExtension parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AuthzExtension parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AuthzExtension> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
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];
getDefaultInstanceForType()
public AuthzExtension getDefaultInstanceForType()
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.
|
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.
|
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.
|
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.
|
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.
|
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];
getLabels() (deprecated)
public Map<String,String> getLabels()
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];
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];
| 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];
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.
|
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.
|
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];
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.
|
getParserForType()
public Parser<AuthzExtension> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
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];
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.
|
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];
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.
|
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.
|
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AuthzExtension.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AuthzExtension.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public AuthzExtension.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
