com.google.cloud.aiplatform.v1beta1

Interface AuthConfig.ApiKeyConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AuthConfig.ApiKeyConfig, AuthConfig.ApiKeyConfig.Builder

Enclosing class:

AuthConfig

public static interface AuthConfig.ApiKeyConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getApiKeySecret() Required.
com.google.protobuf.ByteString	getApiKeySecretBytes() Required.
HttpElementLocation	getHttpElementLocation() Required.
int	getHttpElementLocationValue() Required.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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];

Returns:

The name.

getNameBytes

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];

Returns:

The bytes for name.

getApiKeySecret

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) = { ... }

Returns:

The apiKeySecret.

getApiKeySecretBytes

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) = { ... }

Returns:

The bytes for apiKeySecret.

getHttpElementLocationValue

int getHttpElementLocationValue()

 Required. The location of the API key.
 

.google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];

Returns:

The enum numeric value on the wire for httpElementLocation.

getHttpElementLocation

HttpElementLocation getHttpElementLocation()

 Required. The location of the API key.
 

.google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];

Returns:

The httpElementLocation.