Class: OCI::DataSafe::Models::CreateSecurityAssessmentDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/create_security_assessment_details.rb

Overview

The details used to save a security assessment.

Constant Summary collapse

TARGET_TYPE_ENUM = 
[
  TARGET_TYPE_TARGET_DATABASE = 'TARGET_DATABASE'.freeze,
  TARGET_TYPE_TARGET_DATABASE_GROUP = 'TARGET_DATABASE_GROUP'.freeze
].freeze
TYPE_ENUM = 
[
  TYPE_LATEST = 'LATEST'.freeze,
  TYPE_SAVED = 'SAVED'.freeze,
  TYPE_SAVE_SCHEDULE = 'SAVE_SCHEDULE'.freeze,
  TYPE_COMPARTMENT = 'COMPARTMENT'.freeze,
  TYPE_TEMPLATE = 'TEMPLATE'.freeze,
  TYPE_TEMPLATE_BASELINE = 'TEMPLATE_BASELINE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSecurityAssessmentDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :target_id (String) —

    The value to assign to the #target_id property

  • :target_type (String) —

    The value to assign to the #target_type property

  • :type (String) —

    The value to assign to the #type property

  • :template_assessment_id (String) —

    The value to assign to the #template_assessment_id property

  • :base_security_assessment_id (String) —

    The value to assign to the #base_security_assessment_id property

  • :is_assessment_scheduled (BOOLEAN) —

    The value to assign to the #is_assessment_scheduled property

  • :schedule (String) —

    The value to assign to the #schedule 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



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
217
218
219
220
221
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 154

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.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.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.target_id = attributes[:'targetId'] if attributes[:'targetId']

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

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

  self.target_type = attributes[:'targetType'] if attributes[:'targetType']
  self.target_type = "TARGET_DATABASE" if target_type.nil? && !attributes.key?(:'targetType') # rubocop:disable Style/StringLiterals

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

  self.target_type = attributes[:'target_type'] if attributes[:'target_type']
  self.target_type = "TARGET_DATABASE" if target_type.nil? && !attributes.key?(:'targetType') && !attributes.key?(:'target_type') # rubocop:disable Style/StringLiterals

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

  self.template_assessment_id = attributes[:'templateAssessmentId'] if attributes[:'templateAssessmentId']

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

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

  self.base_security_assessment_id = attributes[:'baseSecurityAssessmentId'] if attributes[:'baseSecurityAssessmentId']

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

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

  self.is_assessment_scheduled = attributes[:'isAssessmentScheduled'] unless attributes[:'isAssessmentScheduled'].nil?

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

  self.is_assessment_scheduled = attributes[:'is_assessment_scheduled'] unless attributes[:'is_assessment_scheduled'].nil?

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

  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']
end

Instance Attribute Details

#base_security_assessment_id ⇒ String

The OCID of the security assessment. The assessment should be of type SAVED. It will be required while creating the template baseline assessment for individual targets to fetch the detailed information from an existing security assessment.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 57

def base_security_assessment_id
  @base_security_assessment_id
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the security assessment.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 27

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. For more information, see Resource Tags Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


94
95
96
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 94

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the security assessment.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 35

def description
  @description
end

#display_name ⇒ String

The display name of the security assessment.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 31

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


88
89
90
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 88

def freeform_tags
  @freeform_tags
end

#is_assessment_scheduled ⇒ BOOLEAN

Indicates whether the assessment is scheduled to run.

Returns:

  • (BOOLEAN) 


61
62
63
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 61

def is_assessment_scheduled
  @is_assessment_scheduled
end

#schedule ⇒ String

To schedule the assessment for running periodically, specify the schedule in this attribute. Create or schedule one assessment per compartment. If not defined, the assessment runs immediately. Format - <version-string>;<version-specific-schedule>

Allowed version strings - "v1" v1's version specific schedule -<ss> <mm> <hh> <day-of-week> <day-of-month> Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = <ss> (So, the allowed range for <ss> is [0, 59]) 2. minutes = <mm> (So, the allowed range for <mm> is [0, 59]) 3. hours = <hh> (So, the allowed range for <hh> is [0, 23]) <day-of-week> can be either '' (without quotes or a number between 1(Monday) and 7(Sunday)) 4. No constraint introduced when it is ''. When not, day of week must equal the given value <day-of-month> can be either '' (without quotes or a number between 1 and 28) 5. No constraint introduced when it is ''. When not, day of month must equal the given value

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 81

def schedule
  @schedule
end

#target_id ⇒ String

The OCID of the target database or target database group on which security assessment is to be run.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 39

def target_id
  @target_id
end

#target_type ⇒ String

The type of security assessment resource whether it is individual or group resource. For individual target use type TARGET_DATABASE and for group resource use type TARGET_DATABASE_GROUP. If not provided, TARGET_DATABASE would be used as default value.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 43

def target_type
  @target_type
end

#template_assessment_id ⇒ String

The OCID of the template assessment. It will be required while creating the template baseline assessment.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 51

def template_assessment_id
  @template_assessment_id
end

#type ⇒ String

The type of the security assessment

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 47

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 97

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'target_id': :'targetId',
    'target_type': :'targetType',
    'type': :'type',
    'template_assessment_id': :'templateAssessmentId',
    'base_security_assessment_id': :'baseSecurityAssessmentId',
    'is_assessment_scheduled': :'isAssessmentScheduled',
    'schedule': :'schedule',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 117

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'target_id': :'String',
    'target_type': :'String',
    'type': :'String',
    'template_assessment_id': :'String',
    'base_security_assessment_id': :'String',
    'is_assessment_scheduled': :'BOOLEAN',
    'schedule': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 246

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    target_id == other.target_id &&
    target_type == other.target_type &&
    type == other.type &&
    template_assessment_id == other.template_assessment_id &&
    base_security_assessment_id == other.base_security_assessment_id &&
    is_assessment_scheduled == other.is_assessment_scheduled &&
    schedule == other.schedule &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 287

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


267
268
269
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 267

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



276
277
278
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 276

def hash
  [compartment_id, display_name, description, target_id, target_type, type, template_assessment_id, base_security_assessment_id, is_assessment_scheduled, schedule, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



320
321
322
323
324
325
326
327
328
329
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 320

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



314
315
316
 
# File 'lib/oci/data_safe/models/create_security_assessment_details.rb', line 314

def to_s
  to_hash.to_s
end