Package com.google.cloud.aiplatform.v1beta1

Class AuthConfig.ApiKeyConfig.Builder

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

  • 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.Builder<AuthConfig.ApiKeyConfig.Builder>

    • clear

      public AuthConfig.ApiKeyConfig.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<AuthConfig.ApiKeyConfig.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<AuthConfig.ApiKeyConfig.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public AuthConfig.ApiKeyConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AuthConfig.ApiKeyConfig.Builder>

    • mergeFrom

      public AuthConfig.ApiKeyConfig.Builder mergeFrom(AuthConfig.ApiKeyConfig other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<AuthConfig.ApiKeyConfig.Builder>

    • mergeFrom

      public AuthConfig.ApiKeyConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AuthConfig.ApiKeyConfig.Builder>
      Throws:
      IOException

    • 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.

    • setName

      public AuthConfig.ApiKeyConfig.Builder setName(String value)
       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];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public AuthConfig.ApiKeyConfig.Builder clearName()
       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];
      Returns:
      This builder for chaining.

    • setNameBytes

      public AuthConfig.ApiKeyConfig.Builder setNameBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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.

    • setApiKeySecret

      public AuthConfig.ApiKeyConfig.Builder setApiKeySecret(String value)
       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) = { ... }
      Parameters:
      value - The apiKeySecret to set.
      Returns:
      This builder for chaining.

    • clearApiKeySecret

      public AuthConfig.ApiKeyConfig.Builder clearApiKeySecret()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setApiKeySecretBytes

      public AuthConfig.ApiKeyConfig.Builder setApiKeySecretBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for apiKeySecret to set.
      Returns:
      This builder for chaining.

    • 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.

    • setHttpElementLocationValue

      public AuthConfig.ApiKeyConfig.Builder setHttpElementLocationValue(int value)
       Required. The location of the API key.
      .google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The enum numeric value on the wire for httpElementLocation to set.
      Returns:
      This builder for chaining.

    • 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.

    • setHttpElementLocation

      public AuthConfig.ApiKeyConfig.Builder setHttpElementLocation(HttpElementLocation value)
       Required. The location of the API key.
      .google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The httpElementLocation to set.
      Returns:
      This builder for chaining.

    • clearHttpElementLocation

      public AuthConfig.ApiKeyConfig.Builder clearHttpElementLocation()
       Required. The location of the API key.
      .google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.