Class: SwaggerClient::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb,
lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Configuration

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 46

def initialize
  @scheme = 'https'
  @host = 'localhost'
  @base_path = 'https://localhost:3780/'
  @api_key = {}
  @api_key_prefix = {}
  @timeout = 0
  @client_side_validation = true
  @verify_ssl = true
  @verify_ssl_host = true
  @params_encoding = nil
  @cert_file = nil
  @key_file = nil
  @debugging = false
  @inject_format = false
  @force_ending_format = false
  @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)

  yield(self) if block_given?
end

Instance Attribute Details

#access_token ⇒ Object

Defines the access token (Bearer) used with OAuth2.



50
51
52
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 50

def access_token
  @access_token
end

#api_key ⇒ Hash

Defines API keys used with API Key authentications.

Examples:

parameter name is “api_key”, API key is “xxx” (e.g. “api_key=xxx” in query string)

config.api_key['api_key'] = 'xxx'

Returns:

  • (Hash) —

    key: parameter name, value: parameter value (API key)



29
30
31
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 29

def api_key
  @api_key
end

#api_key_prefix ⇒ Hash

Defines API key prefixes used with API Key authentications.

Examples:

parameter name is “Authorization”, API key prefix is “Token” (e.g. “Authorization: Token xxx” in headers)

config.api_key_prefix['api_key'] = 'Token'

Returns:

  • (Hash) —

    key: parameter name, value: API key prefix



37
38
39
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 37

def api_key_prefix
  @api_key_prefix
end

#base_path ⇒ Object

Defines url base path



21
22
23
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 21

def base_path
  @base_path
end

#cert_file ⇒ Object

TLS/SSL setting Client certificate file (for client certificate)



110
111
112
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 110

def cert_file
  @cert_file
end

#client_side_validation ⇒ true, false

Set this to false to skip client side validation in the operation. Default to true.

Returns:

  • (true, false) 


79
80
81
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 79

def client_side_validation
  @client_side_validation
end

#debugging ⇒ true, false

Set this to enable/disable debugging. When enabled (set to true), HTTP request/response details will be logged with ‘logger.debug` (see the `logger` attribute). Default to false.

Returns:

  • (true, false) 


57
58
59
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 57

def debugging
  @debugging
end

#force_ending_format ⇒ Object

Returns the value of attribute force_ending_format.



125
126
127
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 125

def force_ending_format
  @force_ending_format
end

#host ⇒ Object

Defines url host



18
19
20
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 18

def host
  @host
end

#inject_format ⇒ Object

Returns the value of attribute inject_format.



123
124
125
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 123

def inject_format
  @inject_format
end

#key_file ⇒ Object

TLS/SSL setting Client private key file (for client certificate)



114
115
116
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 114

def key_file
  @key_file
end

#logger ⇒ #debug

Defines the logger used for debugging. Default to ‘Rails.logger` (when in Rails) or logging to STDOUT.

Returns:

  • (#debug) 


63
64
65
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 63

def logger
  @logger
end

#name ⇒ Object

The name of the configuration value.



17
18
19
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 17

def name
  @name
end

#params_encoding ⇒ Object

Set this to customize parameters encoding of array parameter with multi collectionFormat. Default to nil.

github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96

See Also:

  • params_encoding option of Ethon. Related source code:


121
122
123
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 121

def params_encoding
  @params_encoding
end

#password ⇒ String

Defines the password used with HTTP basic authentication.

Returns:

  • (String) 


47
48
49
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 47

def password
  @password
end

#scheme ⇒ Object

Defines url scheme



15
16
17
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 15

def scheme
  @scheme
end

#ssl_ca_cert ⇒ String

TLS/SSL setting Set this to customize the certificate file to verify the peer.

github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145

Returns:

  • (String) —

    the path to the certificate file

See Also:

  • `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:


106
107
108
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 106

def ssl_ca_cert
  @ssl_ca_cert
end

#temp_folder_path ⇒ String

Defines the temporary folder to store downloaded files (for API endpoints that have file response). Default to use ‘Tempfile`.

Returns:

  • (String) 


70
71
72
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 70

def temp_folder_path
  @temp_folder_path
end

#timeout ⇒ Object

The time limit for HTTP request in seconds. Default to 0 (never times out).



74
75
76
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 74

def timeout
  @timeout
end

#username ⇒ String

Defines the username used with HTTP basic authentication.

Returns:

  • (String) 


42
43
44
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 42

def username
  @username
end

#value ⇒ Object

The configuration value.



20
21
22
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 20

def value
  @value
end

#verify_ssl ⇒ true, false

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Set this to false to skip verifying SSL certificate when calling API from https server. Default to true.

Returns:

  • (true, false) 


88
89
90
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 88

def verify_ssl
  @verify_ssl
end

#verify_ssl_host ⇒ true, false

Note:

Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.

TLS/SSL setting Set this to false to skip verifying SSL host name Default to true.

Returns:

  • (true, false) 


97
98
99
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 97

def verify_ssl_host
  @verify_ssl_host
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



23
24
25
26
27
28
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 23

def self.attribute_map
  {
    :'name' => :'name',
    :'value' => :'value'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



110
111
112
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 110

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.default ⇒ Object

The default Configuration object.



149
150
151
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 149

def self.default
  @@default ||= Configuration.new
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



39
40
41
42
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 39

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



31
32
33
34
35
36
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 31

def self.openapi_types
  {
    :'name' => :'Object',
    :'value' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



88
89
90
91
92
93
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 88

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      value == o.value
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 140

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    SwaggerClient.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 209

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#api_key_with_prefix(param_name) ⇒ Object

Gets API key (with prefix if set).

Parameters:

  • param_name (String) —

    the parameter name of API key auth



179
180
181
182
183
184
185
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 179

def api_key_with_prefix(param_name)
  if @api_key_prefix[param_name]
    "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
  else
    @api_key[param_name]
  end
end

#auth_settings ⇒ Object

Returns Auth Settings hash for api client.



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 193

def auth_settings
  {
    'Basic' =>
      {
        type: 'basic',
        in: 'header',
        key: 'Authorization',
        value: basic_auth_token
      },
  }
end

#base_url ⇒ Object 



173
174
175
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 173

def base_url
  "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
end

#basic_auth_token ⇒ Object

Gets Basic Auth token string



188
189
190
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 188

def basic_auth_token
  'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 117

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#configure {|_self| ... } ⇒ Object

Yields:

  • (_self)

Yield Parameters:



153
154
155
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/configuration.rb', line 153

def configure
  yield(self) if block_given?
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


97
98
99
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 97

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



103
104
105
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 103

def hash
  [name, value].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



70
71
72
73
74
75
76
77
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 70

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



185
186
187
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 185

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 191

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



179
180
181
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 179

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



81
82
83
84
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/configuration.rb', line 81

def valid?
  return false if @name.nil?
  true
end