Class: OCI::DataSafe::Models::CreateUserAssessmentDetails

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

Overview

The details required to save a user assessment.

Constant Summary collapse

TARGET_TYPE_ENUM = 
[
  TARGET_TYPE_TARGET_DATABASE = 'TARGET_DATABASE'.freeze,
  TARGET_TYPE_TARGET_DATABASE_GROUP = 'TARGET_DATABASE_GROUP'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateUserAssessmentDetails

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

  • :description (String) —

    The value to assign to the #description property

  • :display_name (String) —

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

  • :target_id (String) —

    The value to assign to the #target_id property

  • :target_type (String) —

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



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
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/oci/data_safe/models/create_user_assessment_details.rb', line 122

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

  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.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.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.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

#compartment_id ⇒ String

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

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 18

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>>) 


71
72
73
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 71

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the user assessment.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 22

def description
  @description
end

#display_name ⇒ String

The display name of the user assessment.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 26

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>) 


65
66
67
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 65

def freeform_tags
  @freeform_tags
end

#is_assessment_scheduled ⇒ BOOLEAN

Indicates whether the assessment is scheduled to run.

Returns:

  • (BOOLEAN) 


30
31
32
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 30

def is_assessment_scheduled
  @is_assessment_scheduled
end

#schedule ⇒ String

To schedule the assessment for saving 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) 


50
51
52
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 50

def schedule
  @schedule
end

#target_id ⇒ String

[Required] The OCID of the target database or target database group on which user assessment is to be run.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 54

def target_id
  @target_id
end

#target_type ⇒ String

The type of user 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) 


58
59
60
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 58

def target_type
  @target_type
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 74

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

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 91

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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 192

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    description == other.description &&
    display_name == other.display_name &&
    is_assessment_scheduled == other.is_assessment_scheduled &&
    schedule == other.schedule &&
    target_id == other.target_id &&
    target_type == other.target_type &&
    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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 230

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


210
211
212
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 210

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



219
220
221
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 219

def hash
  [compartment_id, description, display_name, is_assessment_scheduled, schedule, target_id, target_type, 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



263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 263

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



257
258
259
 
# File 'lib/oci/data_safe/models/create_user_assessment_details.rb', line 257

def to_s
  to_hash.to_s
end