public sealed class AuthConfig.Types.ApiKeyConfig : IMessage<AuthConfig.Types.ApiKeyConfig>, IEquatable<AuthConfig.Types.ApiKeyConfig>, IDeepCloneable<AuthConfig.Types.ApiKeyConfig>, IBufferMessage, IMessageReference documentation and code samples for the Cloud AI Platform v1beta1 API class AuthConfig.Types.ApiKeyConfig.
Config for authentication with API key.
Implements
IMessageAuthConfigTypesApiKeyConfig, IEquatableAuthConfigTypesApiKeyConfig, IDeepCloneableAuthConfigTypesApiKeyConfig, IBufferMessage, IMessageNamespace
Google.Cloud.AIPlatform.V1Beta1Assembly
Google.Cloud.AIPlatform.V1Beta1.dll
Constructors
ApiKeyConfig()
public ApiKeyConfig()ApiKeyConfig(ApiKeyConfig)
public ApiKeyConfig(AuthConfig.Types.ApiKeyConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
AuthConfigTypesApiKeyConfig |
Properties
ApiKeySecret
public string ApiKeySecret { get; set; }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.accesspermission 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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ApiKeySecretAsSecretVersionName
public SecretVersionName ApiKeySecretAsSecretVersionName { get; set; }SecretVersionName-typed view over the ApiKeySecret resource name property.
| Property Value | |
|---|---|
| Type | Description |
SecretVersionName |
|
HttpElementLocation
public HttpElementLocation HttpElementLocation { get; set; }Required. The location of the API key.
| Property Value | |
|---|---|
| Type | Description |
HttpElementLocation |
|
Name
public string Name { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|