Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Tool::Authentication::ApiKeyConfig (v1.13.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::Tool::Authentication::ApiKeyConfig.

Config for authentication with API key.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#api_key

def api_key() -> ::String
Returns
  • (::String) — Optional. The API key. If the secret_version_for_api_key field is set, this field will be ignored.

#api_key=

def api_key=(value) -> ::String
Parameter
  • value (::String) — Optional. The API key. If the secret_version_for_api_key field is set, this field will be ignored.
Returns
  • (::String) — Optional. The API key. If the secret_version_for_api_key field is set, this field will be ignored.

#key_name

def key_name() -> ::String
Returns
  • (::String) — 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=

#key_name=

def key_name=(value) -> ::String
Parameter
  • value (::String) — 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=
Returns
  • (::String) — 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=

#request_location

def request_location() -> ::Google::Cloud::Dialogflow::V2::Tool::Authentication::RequestLocation
Returns

#request_location=

def request_location=(value) -> ::Google::Cloud::Dialogflow::V2::Tool::Authentication::RequestLocation
Parameter
Returns

#secret_version_for_api_key

def secret_version_for_api_key() -> ::String
Returns
  • (::String) — 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}

#secret_version_for_api_key=

def secret_version_for_api_key=(value) -> ::String
Parameter
  • value (::String) — 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}
Returns
  • (::String) — 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}