Interface AuthzExtensionOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
AuthzExtension,AuthzExtension.Builder
@Generated
public interface AuthzExtensionOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsLabels(String key) Optional.Required.com.google.protobuf.ByteStringRequired.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Optional.com.google.protobuf.ByteStringOptional.booleanOptional.getForwardHeaders(int index) Optional.com.google.protobuf.ByteStringgetForwardHeadersBytes(int index) Optional.intOptional.Optional.Deprecated.intOptional.Optional.getLabelsOrDefault(String key, String defaultValue) Optional.getLabelsOrThrow(String key) Optional.Required.intRequired.com.google.protobuf.StructOptional.com.google.protobuf.StructOrBuilderOptional.getName()Required.com.google.protobuf.ByteStringRequired.Required.com.google.protobuf.ByteStringRequired.com.google.protobuf.DurationRequired.com.google.protobuf.DurationOrBuilderRequired.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Optional.intOptional.booleanOutput only.booleanOptional.booleanRequired.booleanOutput only.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
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:
- The name.
-
getNameBytes
com.google.protobuf.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:
- The bytes for name.
-
hasCreateTime
boolean hasCreateTime()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasUpdateTime
boolean hasUpdateTime()Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
com.google.protobuf.Timestamp getUpdateTime()Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getDescription
String getDescription()Optional. A human-readable description of the resource.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()Optional. A human-readable description of the resource.
string description = 4 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for description.
-
getLabelsCount
int getLabelsCount()Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL]; -
containsLabels
Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL]; -
getLabels
Deprecated.UsegetLabelsMap()instead. -
getLabelsMap
Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL]; -
getLabelsOrDefault
Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL]; -
getLabelsOrThrow
Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.
map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL]; -
getLoadBalancingSchemeValue
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](https://cloud.google.com/load-balancing/docs/backend-service).
.google.cloud.networkservices.v1.LoadBalancingScheme load_balancing_scheme = 6 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The enum numeric value on the wire for loadBalancingScheme.
-
getLoadBalancingScheme
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](https://cloud.google.com/load-balancing/docs/backend-service).
.google.cloud.networkservices.v1.LoadBalancingScheme load_balancing_scheme = 6 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The loadBalancingScheme.
-
getAuthority
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:
- The authority.
-
getAuthorityBytes
com.google.protobuf.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:
- The bytes for authority.
-
getService
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](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) 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:
- The service.
-
getServiceBytes
com.google.protobuf.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](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) 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:
- The bytes for service.
-
hasTimeout
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:
- Whether the timeout field is set.
-
getTimeout
com.google.protobuf.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:
- The timeout.
-
getTimeoutOrBuilder
com.google.protobuf.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]; -
getFailOpen
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:
- The failOpen.
-
hasMetadata
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:
- Whether the metadata field is set.
-
getMetadata
com.google.protobuf.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:
- The metadata.
-
getMetadataOrBuilder
com.google.protobuf.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]; -
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:
- A list containing the forwardHeaders.
-
getForwardHeadersCount
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:
- The count of forwardHeaders.
-
getForwardHeaders
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:
index- The index of the element to return.- Returns:
- The forwardHeaders at the given index.
-
getForwardHeadersBytes
com.google.protobuf.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];- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the forwardHeaders at the given index.
-
getWireFormatValue
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:
- The enum numeric value on the wire for wireFormat.
-
getWireFormat
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:
- The wireFormat.
-