Class: SwaggerClient::SharedCredential

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SharedCredential

Initializes the object

Parameters:

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

    Model attributes in the form of hash



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 75

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SwaggerClient::SharedCredential` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SwaggerClient::SharedCredential`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'account')
    self. = attributes[:'account']
  end

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'host_restriction')
    self.host_restriction = attributes[:'host_restriction']
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'port_restriction')
    self.port_restriction = attributes[:'port_restriction']
  end

  if attributes.key?(:'site_assignment')
    self.site_assignment = attributes[:'site_assignment']
  end

  if attributes.key?(:'sites')
    if (value = attributes[:'sites']).is_a?(Array)
      self.sites = value
    end
  end
end

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



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

def 
  @account
end

#description ⇒ Object

The description of the credential.



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

def description
  @description
end

#host_restriction ⇒ Object

The host name or IP address that you want to restrict the credentials to.



22
23
24
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 22

def host_restriction
  @host_restriction
end

#id ⇒ Object

The identifier of the credential.



25
26
27
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 25

def id
  @id
end

#name ⇒ Object

The name of the credential.



28
29
30
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 28

def name
  @name
end

#port_restriction ⇒ Object

Further restricts the credential to attempt to authenticate on a specific port.



31
32
33
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 31

def port_restriction
  @port_restriction
end

#site_assignment ⇒ Object

Assigns the shared scan credential either to be available to all sites or to a specific list of sites. The following table describes each supported value: | Value | Description | | ———- | —————- | | ‘"all-sites"` | The shared scan credential is assigned to all current and future sites. | | `"specific-sites"` | The shared scan credential is assigned to zero sites by default. Administrators must explicitly assign sites to the shared credential. | Shared scan credentials assigned to a site can disabled within the site configuration, if needed.



34
35
36
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 34

def site_assignment
  @site_assignment
end

#sites ⇒ Object

List of site identifiers. These sites are explicitly assigned access to the shared scan credential, allowing the site to use the credential for authentication during a scan. This property can only be set if the value of property ‘siteAssignment` is set to `"specific-sites"`. When the property `siteAssignment` is set to `"all-sites"`, this property will be `null`.



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

def sites
  @sites
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 40

def self.attribute_map
  {
    :'account' => :'account',
    :'description' => :'description',
    :'host_restriction' => :'hostRestriction',
    :'id' => :'id',
    :'name' => :'name',
    :'port_restriction' => :'portRestriction',
    :'site_assignment' => :'siteAssignment',
    :'sites' => :'sites'
  }
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



181
182
183
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 181

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



68
69
70
71
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 68

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

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 54

def self.openapi_types
  {
    :'account' => :'Object',
    :'description' => :'Object',
    :'host_restriction' => :'Object',
    :'id' => :'Object',
    :'name' => :'Object',
    :'port_restriction' => :'Object',
    :'site_assignment' => :'Object',
    :'sites' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      description == o.description &&
      host_restriction == o.host_restriction &&
      id == o.id &&
      name == o.name &&
      port_restriction == o.port_restriction &&
      site_assignment == o.site_assignment &&
      sites == o.sites
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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 211

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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 280

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

#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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 188

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


168
169
170
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



174
175
176
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 174

def hash
  [, description, host_restriction, id, name, port_restriction, site_assignment, sites].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



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 125

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

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @site_assignment.nil?
    invalid_properties.push('invalid value for "site_assignment", site_assignment 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



256
257
258
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 256

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



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 262

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



250
251
252
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 250

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



144
145
146
147
148
149
 
# File 'lib/service/api/rapid7_insightvm_client/lib/swagger_client/models/shared_credential.rb', line 144

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