Class: Google::Apis::CesV1::LfA2aV1ApiKeySecurityScheme

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

Overview

Defines a security scheme using an API key.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LfA2aV1ApiKeySecurityScheme

Returns a new instance of LfA2aV1ApiKeySecurityScheme.



4436
4437
4438
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4436

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

Instance Attribute Details

#description ⇒ String

An optional description for the security scheme. Corresponds to the JSON property description

Returns:

  • (String) 


4423
4424
4425
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4423

def description
  @description
end

#location ⇒ String

Required. The location of the API key. Valid values are "query", "header", or " cookie". Corresponds to the JSON property location

Returns:

  • (String) 


4429
4430
4431
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4429

def location
  @location
end

#name ⇒ String

Required. The name of the header, query, or cookie parameter to be used. Corresponds to the JSON property name

Returns:

  • (String) 


4434
4435
4436
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4434

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4441
4442
4443
4444
4445
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4441

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @location = args[:location] if args.key?(:location)
  @name = args[:name] if args.key?(:name)
end