Class: Google::Cloud::Dialogflow::V2::Tool::Authentication::ApiKeyConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/v2/tool.rb

Overview

Config for authentication with API key.

Instance Attribute Summary collapse

Instance Attribute Details

#api_key ⇒ ::String

Returns 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.



344
345
346
347
 
# File 'proto_docs/google/cloud/dialogflow/v2/tool.rb', line 344

class ApiKeyConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#key_name ⇒ ::String

Returns 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=", "X-Api-Key" would be the parameter name.

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=", "X-Api-Key" would be the parameter name.



344
345
346
347
 
# File 'proto_docs/google/cloud/dialogflow/v2/tool.rb', line 344

class ApiKeyConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#request_location ⇒ ::Google::Cloud::Dialogflow::V2::Tool::Authentication::RequestLocation

Returns Required. Key location in the request.

Returns:



344
345
346
347
 
# File 'proto_docs/google/cloud/dialogflow/v2/tool.rb', line 344

class ApiKeyConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#secret_version_for_api_key ⇒ ::String

Returns 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}



344
345
346
347
 
# File 'proto_docs/google/cloud/dialogflow/v2/tool.rb', line 344

class ApiKeyConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end