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.



4420
4421
4422
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4420

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) 


4407
4408
4409
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4407

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) 


4413
4414
4415
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4413

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) 


4418
4419
4420
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4418

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4425
4426
4427
4428
4429
 
# File 'lib/google/apis/ces_v1/classes.rb', line 4425

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