- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static interface AuthConfig.ApiKeyConfigOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getApiKeySecret()
public abstract 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 | |
---|---|
Type | Description |
String | The apiKeySecret. |
getApiKeySecretBytes()
public abstract 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 | |
---|---|
Type | Description |
ByteString | The bytes for apiKeySecret. |
getHttpElementLocation()
public abstract HttpElementLocation getHttpElementLocation()
Required. The location of the API key.
.google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
HttpElementLocation | The httpElementLocation. |
getHttpElementLocationValue()
public abstract int getHttpElementLocationValue()
Required. The location of the API key.
.google.cloud.aiplatform.v1beta1.HttpElementLocation http_element_location = 3 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
int | The enum numeric value on the wire for httpElementLocation. |
getName()
public abstract 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 | |
---|---|
Type | Description |
String | The name. |
getNameBytes()
public abstract 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 | |
---|---|
Type | Description |
ByteString | The bytes for name. |