Interface Tool.Authentication.ApiKeyConfigOrBuilder (0.47.0)

public static interface Tool.Authentication.ApiKeyConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getApiKey()

public abstract String getApiKey()

Required. The API key.

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

Returns
Type Description
String

The apiKey.

getApiKeyBytes()

public abstract ByteString getApiKeyBytes()

Required. The API key.

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

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.cx.v3beta1.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.cx.v3beta1.Tool.Authentication.RequestLocation request_location = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for requestLocation.