Class AuthzExtension

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.networkservices.v1.AuthzExtension
All Implemented Interfaces:
AuthzExtensionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class AuthzExtension extends com.google.protobuf.GeneratedMessage 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
See Also:
  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:
    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:
    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:
    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:
    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:
    • LOAD_BALANCING_SCHEME_FIELD_NUMBER

      public static final int LOAD_BALANCING_SCHEME_FIELD_NUMBER
      See Also:
    • AUTHORITY_FIELD_NUMBER

      public static final int AUTHORITY_FIELD_NUMBER
      See Also:
    • SERVICE_FIELD_NUMBER

      public static final int SERVICE_FIELD_NUMBER
      See Also:
    • TIMEOUT_FIELD_NUMBER

      public static final int TIMEOUT_FIELD_NUMBER
      See Also:
    • FAIL_OPEN_FIELD_NUMBER

      public static final int FAIL_OPEN_FIELD_NUMBER
      See Also:
    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:
    • FORWARD_HEADERS_FIELD_NUMBER

      public static final int FORWARD_HEADERS_FIELD_NUMBER
      See Also:
    • WIRE_FORMAT_FIELD_NUMBER

      public static final int WIRE_FORMAT_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • 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];
      Specified by:
      getName in interface AuthzExtensionOrBuilder
      Returns:
      The name.
    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface AuthzExtensionOrBuilder
      Returns:
      The bytes for name.
    • 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];
      Specified by:
      hasCreateTime in interface AuthzExtensionOrBuilder
      Returns:
      Whether the createTime field is set.
    • getCreateTime

      public 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];
      Specified by:
      getCreateTime in interface AuthzExtensionOrBuilder
      Returns:
      The createTime.
    • getCreateTimeOrBuilder

      public 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];
      Specified by:
      getCreateTimeOrBuilder in interface AuthzExtensionOrBuilder
    • 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];
      Specified by:
      hasUpdateTime in interface AuthzExtensionOrBuilder
      Returns:
      Whether the updateTime field is set.
    • getUpdateTime

      public 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];
      Specified by:
      getUpdateTime in interface AuthzExtensionOrBuilder
      Returns:
      The updateTime.
    • getUpdateTimeOrBuilder

      public 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];
      Specified by:
      getUpdateTimeOrBuilder in interface AuthzExtensionOrBuilder
    • getDescription

      public String getDescription()
       Optional. A human-readable description of the resource.
       
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface AuthzExtensionOrBuilder
      Returns:
      The description.
    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. A human-readable description of the resource.
       
      string description = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface AuthzExtensionOrBuilder
      Returns:
      The bytes for description.
    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: AuthzExtensionOrBuilder
       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];
      Specified by:
      getLabelsCount in interface AuthzExtensionOrBuilder
    • containsLabels

      public boolean containsLabels(String key)
       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];
      Specified by:
      containsLabels in interface AuthzExtensionOrBuilder
    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface AuthzExtensionOrBuilder
    • getLabelsMap

      public Map<String,String> 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];
      Specified by:
      getLabelsMap in interface AuthzExtensionOrBuilder
    • getLabelsOrDefault

      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](/compute/docs/labeling-resources#requirements) for Google Cloud
       resources.
       
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface AuthzExtensionOrBuilder
    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       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];
      Specified by:
      getLabelsOrThrow in interface AuthzExtensionOrBuilder
    • 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](https://cloud.google.com/load-balancing/docs/backend-service).
       
      .google.cloud.networkservices.v1.LoadBalancingScheme load_balancing_scheme = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getLoadBalancingSchemeValue in interface AuthzExtensionOrBuilder
      Returns:
      The enum numeric value on the wire for loadBalancingScheme.
    • 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](https://cloud.google.com/load-balancing/docs/backend-service).
       
      .google.cloud.networkservices.v1.LoadBalancingScheme load_balancing_scheme = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getLoadBalancingScheme in interface AuthzExtensionOrBuilder
      Returns:
      The loadBalancingScheme.
    • 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];
      Specified by:
      getAuthority in interface AuthzExtensionOrBuilder
      Returns:
      The authority.
    • getAuthorityBytes

      public 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];
      Specified by:
      getAuthorityBytes in interface AuthzExtensionOrBuilder
      Returns:
      The bytes for authority.
    • 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](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];
      Specified by:
      getService in interface AuthzExtensionOrBuilder
      Returns:
      The service.
    • getServiceBytes

      public 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];
      Specified by:
      getServiceBytes in interface AuthzExtensionOrBuilder
      Returns:
      The bytes for service.
    • 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];
      Specified by:
      hasTimeout in interface AuthzExtensionOrBuilder
      Returns:
      Whether the timeout field is set.
    • getTimeout

      public 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];
      Specified by:
      getTimeout in interface AuthzExtensionOrBuilder
      Returns:
      The timeout.
    • getTimeoutOrBuilder

      public 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];
      Specified by:
      getTimeoutOrBuilder in interface AuthzExtensionOrBuilder
    • 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];
      Specified by:
      getFailOpen in interface AuthzExtensionOrBuilder
      Returns:
      The failOpen.
    • 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];
      Specified by:
      hasMetadata in interface AuthzExtensionOrBuilder
      Returns:
      Whether the metadata field is set.
    • getMetadata

      public 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];
      Specified by:
      getMetadata in interface AuthzExtensionOrBuilder
      Returns:
      The metadata.
    • getMetadataOrBuilder

      public 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];
      Specified by:
      getMetadataOrBuilder in interface AuthzExtensionOrBuilder
    • getForwardHeadersList

      public com.google.protobuf.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];
      Specified by:
      getForwardHeadersList in interface AuthzExtensionOrBuilder
      Returns:
      A list containing the forwardHeaders.
    • 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];
      Specified by:
      getForwardHeadersCount in interface AuthzExtensionOrBuilder
      Returns:
      The count of forwardHeaders.
    • getForwardHeaders

      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];
      Specified by:
      getForwardHeaders in interface AuthzExtensionOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The forwardHeaders at the given index.
    • getForwardHeadersBytes

      public 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];
      Specified by:
      getForwardHeadersBytes in interface AuthzExtensionOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the forwardHeaders at the given index.
    • 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];
      Specified by:
      getWireFormatValue in interface AuthzExtensionOrBuilder
      Returns:
      The enum numeric value on the wire for wireFormat.
    • 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];
      Specified by:
      getWireFormat in interface AuthzExtensionOrBuilder
      Returns:
      The wireFormat.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static AuthzExtension parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static AuthzExtension parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static AuthzExtension parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static AuthzExtension parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static AuthzExtension parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static AuthzExtension parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static AuthzExtension parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static AuthzExtension parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static AuthzExtension parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static AuthzExtension parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static AuthzExtension parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static AuthzExtension parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public AuthzExtension.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static AuthzExtension.Builder newBuilder()
    • newBuilder

      public static AuthzExtension.Builder newBuilder(AuthzExtension prototype)
    • toBuilder

      public AuthzExtension.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected AuthzExtension.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static AuthzExtension getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<AuthzExtension> parser()
    • getParserForType

      public com.google.protobuf.Parser<AuthzExtension> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public AuthzExtension getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder