Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3ToolAuthenticationApiKeyConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb

Overview

Config for authentication with API key.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3ToolAuthenticationApiKeyConfig

Returns a new instance of GoogleCloudDialogflowCxV3ToolAuthenticationApiKeyConfig.



9174
9175
9176
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9174

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#api_key ⇒ String

Optional. The API key. If the secret_version_for_api_key field is set, this field will be ignored. Corresponds to the JSON property apiKey

Returns:

  • (String) 


9153
9154
9155
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9153

def api_key
  @api_key
end

#key_name ⇒ 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. Corresponds to the JSON property keyName

Returns:

  • (String) 


9160
9161
9162
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9160

def key_name
  @key_name
end

#request_location ⇒ String

Required. Key location in the request. Corresponds to the JSON property requestLocation

Returns:

  • (String) 


9165
9166
9167
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9165

def request_location
  @request_location
end

#secret_version_for_api_key ⇒ 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` Corresponds to the JSON propertysecretVersionForApiKey`

Returns:

  • (String) 


9172
9173
9174
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9172

def secret_version_for_api_key
  @secret_version_for_api_key
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9179
9180
9181
9182
9183
9184
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 9179

def update!(**args)
  @api_key = args[:api_key] if args.key?(:api_key)
  @key_name = args[:key_name] if args.key?(:key_name)
  @request_location = args[:request_location] if args.key?(:request_location)
  @secret_version_for_api_key = args[:secret_version_for_api_key] if args.key?(:secret_version_for_api_key)
end