Class: OCI::VulnerabilityScanning::Models::HostScanTarget

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vulnerability_scanning/models/host_scan_target.rb

Overview

A host scan target (application of a host scan recipe to a compartment or list of hosts)

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HostScanTarget

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :target_compartment_id (String) —

    The value to assign to the #target_compartment_id property

  • :instance_ids (Array<String>) —

    The value to assign to the #instance_ids property

  • :host_scan_recipe_id (String) —

    The value to assign to the #host_scan_recipe_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 141

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.description = attributes[:'description'] if attributes[:'description']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.target_compartment_id = attributes[:'targetCompartmentId'] if attributes[:'targetCompartmentId']

  raise 'You cannot provide both :targetCompartmentId and :target_compartment_id' if attributes.key?(:'targetCompartmentId') && attributes.key?(:'target_compartment_id')

  self.target_compartment_id = attributes[:'target_compartment_id'] if attributes[:'target_compartment_id']

  self.instance_ids = attributes[:'instanceIds'] if attributes[:'instanceIds']

  raise 'You cannot provide both :instanceIds and :instance_ids' if attributes.key?(:'instanceIds') && attributes.key?(:'instance_ids')

  self.instance_ids = attributes[:'instance_ids'] if attributes[:'instance_ids']

  self.host_scan_recipe_id = attributes[:'hostScanRecipeId'] if attributes[:'hostScanRecipeId']

  raise 'You cannot provide both :hostScanRecipeId and :host_scan_recipe_id' if attributes.key?(:'hostScanRecipeId') && attributes.key?(:'host_scan_recipe_id')

  self.host_scan_recipe_id = attributes[:'host_scan_recipe_id'] if attributes[:'host_scan_recipe_id']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

  raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags')

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] Compartment ID of the object (this).

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 36

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


72
73
74
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 72

def defined_tags
  @defined_tags
end

#description ⇒ String

Target description.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 32

def description
  @description
end

#display_name ⇒ String

[Required] Target identifier, which can be renamed.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 28

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


66
67
68
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 66

def freeform_tags
  @freeform_tags
end

#host_scan_recipe_id ⇒ String

[Required] ID of the host scan recipe this target applies.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 48

def host_scan_recipe_id
  @host_scan_recipe_id
end

#id ⇒ String

[Required] Unique identifier of the config that is immutable on creation

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 24

def id
  @id
end

#instance_ids ⇒ Array<String>

List of compute instance IDs to target (optional). If empty, targets the entire targetCompartmentId.

Returns:

  • (Array<String>) 


44
45
46
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 44

def instance_ids
  @instance_ids
end

#lifecycle_state ⇒ String

[Required] The current state of the config.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 52

def lifecycle_state
  @lifecycle_state
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


78
79
80
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 78

def system_tags
  @system_tags
end

#target_compartment_id ⇒ String

[Required] Compartment ID to target. If a list of hosts is provided, all hosts must be in this compartment.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 40

def target_compartment_id
  @target_compartment_id
end

#time_created ⇒ DateTime

[Required] Date and time the target was created, format as described in RFC 3339

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 56

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] Date and time the target was last updated, format as described in RFC 3339

Returns:

  • (DateTime) 


60
61
62
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 60

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 81

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'target_compartment_id': :'targetCompartmentId',
    'instance_ids': :'instanceIds',
    'host_scan_recipe_id': :'hostScanRecipeId',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 102

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'target_compartment_id': :'String',
    'instance_ids': :'Array<String>',
    'host_scan_recipe_id': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 238

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    target_compartment_id == other.target_compartment_id &&
    instance_ids == other.instance_ids &&
    host_scan_recipe_id == other.host_scan_recipe_id &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 280

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


260
261
262
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 260

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



269
270
271
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 269

def hash
  [id, display_name, description, compartment_id, target_compartment_id, instance_ids, host_scan_recipe_id, lifecycle_state, time_created, time_updated, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



313
314
315
316
317
318
319
320
321
322
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 313

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



307
308
309
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_target.rb', line 307

def to_s
  to_hash.to_s
end