Interface Tool.Authentication.ApiKeyConfigOrBuilder (4.87.0)

Version latest

• 4.87.0 (latest)
• 4.86.0
• 4.84.0
• 4.82.0
• 4.81.0
• 4.80.0
• 4.79.0
• 4.78.0
• 4.76.0
• 4.74.0
• 4.73.0
• 4.70.0
• 4.69.0
• 4.68.0
• 4.66.0
• 4.65.0
• 4.64.0
• 4.63.0
• 4.62.0
• 4.61.0
• 4.60.0
• 4.59.0
• 4.58.0
• 4.57.0
• 4.55.0
• 4.54.0
• 4.53.0
• 4.52.0
• 4.51.0
• 4.50.0
• 4.49.0
• 4.48.0
• 4.47.0
• 4.46.0
• 4.45.0
• 4.43.0
• 4.42.0
• 4.41.0
• 4.40.0
• 4.39.0
• 4.38.0
• 4.37.0
• 4.36.0
• 4.35.0
• 4.34.0
• 4.33.0
• 4.30.0
• 4.29.0
• 4.28.0
• 4.27.0
• 4.26.0
• 4.25.0
• 4.24.0
• 4.23.0
• 4.22.0
• 4.21.0
• 4.20.0
• 4.19.0
• 4.18.0
• 4.17.0
• 4.15.0
• 4.14.0
• 4.13.0
• 4.12.0
• 4.11.0
• 4.10.0
• 4.9.1
• 4.8.6
• 4.7.5
• 4.6.0
• 4.5.11
• 4.4.0
• 4.3.1

public static interface Tool.Authentication.ApiKeyConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApiKey()

public abstract String getApiKey()

Optional. The API key. If the secret_version_for_api_key field is set, this field will be ignored.

string api_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The apiKey.

getApiKeyBytes()

public abstract ByteString getApiKeyBytes()

Optional. The API key. If the secret_version_for_api_key field is set, this field will be ignored.

string api_key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for apiKey.

getKeyName()

public abstract String getKeyName()

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.

string key_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The keyName.

getKeyNameBytes()

public abstract ByteString getKeyNameBytes()

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.

string key_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for keyName.

getRequestLocation()

public abstract Tool.Authentication.RequestLocation getRequestLocation()

Required. Key location in the request.

.google.cloud.dialogflow.v2beta1.Tool.Authentication.RequestLocation request_location = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Tool.Authentication.RequestLocation	The requestLocation.

getRequestLocationValue()

public abstract int getRequestLocationValue()

Required. Key location in the request.

.google.cloud.dialogflow.v2beta1.Tool.Authentication.RequestLocation request_location = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The enum numeric value on the wire for requestLocation.

getSecretVersionForApiKey()

public abstract String getSecretVersionForApiKey()

Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the api_key field will be ignored. Format: projects/{project}/secrets/{secret}/versions/{version}

string secret_version_for_api_key = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The secretVersionForApiKey.

getSecretVersionForApiKeyBytes()

public abstract ByteString getSecretVersionForApiKeyBytes()

Optional. The name of the SecretManager secret version resource storing the API key. If this field is set, the api_key field will be ignored. Format: projects/{project}/secrets/{secret}/versions/{version}

string secret_version_for_api_key = 4 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for secretVersionForApiKey.