Gemini Enterprise for Customer Experience v1 API - Class ApiKeyConfig (1.0.0-beta01) 

public sealed class ApiKeyConfig : IMessage<ApiKeyConfig>, IEquatable<ApiKeyConfig>, IDeepCloneable<ApiKeyConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1 API class ApiKeyConfig.

Configurations for authentication with API key.

Inheritance

object > ApiKeyConfig

Namespace

Google.Cloud.Ces.V1

Assembly

Google.Cloud.Ces.V1.dll

Constructors

ApiKeyConfig()

public ApiKeyConfig()

ApiKeyConfig(ApiKeyConfig)

public ApiKeyConfig(ApiKeyConfig other)
Parameter
Name Description
other ApiKeyConfig

Properties

ApiKeySecretVersion

public string ApiKeySecretVersion { get; set; }

Required. The name of the SecretManager secret version resource storing the API key. Format: projects/{project}/secrets/{secret}/versions/{version}

Note: You should grant roles/secretmanager.secretAccessor role to the CES service agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.

Property Value
Type Description
string

ApiKeySecretVersionAsSecretVersionName

public SecretVersionName ApiKeySecretVersionAsSecretVersionName { get; set; }

SecretVersionName-typed view over the ApiKeySecretVersion resource name property.

Property Value
Type Description
SecretVersionName

KeyName

public string KeyName { get; set; }

Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=<API KEY>", "X-Api-Key" would be the parameter name.

Property Value
Type Description
string

RequestLocation

public ApiKeyConfig.Types.RequestLocation RequestLocation { get; set; }

Required. Key location in the request.

Property Value
Type Description
ApiKeyConfigTypesRequestLocation