Package com.google.cloud.aiplatform.v1beta1

Class AuthConfig.ApiKeyConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1beta1.AuthConfig.ApiKeyConfig
All Implemented Interfaces:
AuthConfig.ApiKeyConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
AuthConfig
public static final class AuthConfig.ApiKeyConfig extends com.google.protobuf.GeneratedMessage implements AuthConfig.ApiKeyConfigOrBuilder
 Config for authentication with API key.
Protobuf type google.cloud.aiplatform.v1beta1.AuthConfig.ApiKeyConfig
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • API_KEY_SECRET_FIELD_NUMBER

      public static final int API_KEY_SECRET_FIELD_NUMBER
      See Also:

    • HTTP_ELEMENT_LOCATION_FIELD_NUMBER

      public static final int HTTP_ELEMENT_LOCATION_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       Required. The parameter name of the API key.
 E.g. If the API request is "https://example.com/act?api_key=<API KEY>",
 "api_key" would be the parameter name.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getName in interface AuthConfig.ApiKeyConfigOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. The parameter name of the API key.
 E.g. If the API request is "https://example.com/act?api_key=<API KEY>",
 "api_key" would be the parameter name.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNameBytes in interface AuthConfig.ApiKeyConfigOrBuilder
      Returns:
      The bytes for name.

    • getApiKeySecret

      public String getApiKeySecret()
       Required. The name of the SecretManager secret version resource storing
 the API key. Format:
 `projects/{project}/secrets/{secrete}/versions/{version}`

 - If specified, the `secretmanager.versions.access` permission should be
 granted to Vertex AI Extension Service Agent
 (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 on the specified resource.
      string api_key_secret = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getApiKeySecret in interface AuthConfig.ApiKeyConfigOrBuilder
      Returns:
      The apiKeySecret.

    • getApiKeySecretBytes

      public com.google.protobuf.ByteString getApiKeySecretBytes()
       Required. The name of the SecretManager secret version resource storing
 the API key. Format:
 `projects/{project}/secrets/{secrete}/versions/{version}`

 - If specified, the `secretmanager.versions.access` permission should be
 granted to Vertex AI Extension Service Agent
 (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 on the specified resource.
      string api_key_secret = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getApiKeySecretBytes in interface AuthConfig.ApiKeyConfigOrBuilder
      Returns:
      The bytes for apiKeySecret.

    • getHttpElementLocationValue

      public int getHttpElementLocationValue()
       Required. The location of the API key.
      .google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getHttpElementLocationValue in interface AuthConfig.ApiKeyConfigOrBuilder
      Returns:
      The enum numeric value on the wire for httpElementLocation.

    • getHttpElementLocation

      public HttpElementLocation getHttpElementLocation()
       Required. The location of the API key.
      .google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getHttpElementLocation in interface AuthConfig.ApiKeyConfigOrBuilder
      Returns:
      The httpElementLocation.

    • 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 AuthConfig.ApiKeyConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static AuthConfig.ApiKeyConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static AuthConfig.ApiKeyConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AuthConfig.ApiKeyConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AuthConfig.ApiKeyConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AuthConfig.ApiKeyConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AuthConfig.ApiKeyConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AuthConfig.ApiKeyConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public AuthConfig.ApiKeyConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static AuthConfig.ApiKeyConfig.Builder newBuilder()

    • newBuilder

      public static AuthConfig.ApiKeyConfig.Builder newBuilder(AuthConfig.ApiKeyConfig prototype)

    • toBuilder

      public AuthConfig.ApiKeyConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected AuthConfig.ApiKeyConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static AuthConfig.ApiKeyConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AuthConfig.ApiKeyConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<AuthConfig.ApiKeyConfig> 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 AuthConfig.ApiKeyConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder