Class: OCI::DatabaseMigration::Models::Assessor

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_migration/models/assessor.rb

Overview

Assessor resource

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.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 = {}) ⇒ Assessor

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
217
218
219
220
# File 'lib/oci/database_migration/models/assessor.rb', line 146

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

  self.assessment_id = attributes[:'assessmentId'] if attributes[:'assessmentId']

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

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

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

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

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

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

  self.help_link_text = attributes[:'helpLinkText'] if attributes[:'helpLinkText']

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

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

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

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

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

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

  self.assessor_result = attributes[:'assessorResult'] if attributes[:'assessorResult']

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

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

  self.checks_summary = attributes[:'checksSummary'] if attributes[:'checksSummary']

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

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

  self.has_script = attributes[:'hasScript'] unless attributes[:'hasScript'].nil?
  self.has_script = false if has_script.nil? && !attributes.key?(:'hasScript') # rubocop:disable Style/StringLiterals

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

  self.has_script = attributes[:'has_script'] unless attributes[:'has_script'].nil?
  self.has_script = false if has_script.nil? && !attributes.key?(:'hasScript') && !attributes.key?(:'has_script') # rubocop:disable Style/StringLiterals

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

  self.does_script_require_restart = attributes[:'doesScriptRequireRestart'] unless attributes[:'doesScriptRequireRestart'].nil?
  self.does_script_require_restart = false if does_script_require_restart.nil? && !attributes.key?(:'doesScriptRequireRestart') # rubocop:disable Style/StringLiterals

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

  self.does_script_require_restart = attributes[:'does_script_require_restart'] unless attributes[:'does_script_require_restart'].nil?
  self.does_script_require_restart = false if does_script_require_restart.nil? && !attributes.key?(:'doesScriptRequireRestart') && !attributes.key?(:'does_script_require_restart') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#actionsArray<OCI::DatabaseMigration::Models::AssessorAction>

[Required] Assessor actions.



58
59
60
# File 'lib/oci/database_migration/models/assessor.rb', line 58

def actions
  @actions
end

#assessment_idString

[Required] The OCID of the resource being referenced.

Returns:

  • (String)


23
24
25
# File 'lib/oci/database_migration/models/assessor.rb', line 23

def assessment_id
  @assessment_id
end

#assessor_groupOCI::DatabaseMigration::Models::AssessorGroup



54
55
56
# File 'lib/oci/database_migration/models/assessor.rb', line 54

def assessor_group
  @assessor_group
end

#assessor_resultString

The Assessor Result text.

Returns:

  • (String)


62
63
64
# File 'lib/oci/database_migration/models/assessor.rb', line 62

def assessor_result
  @assessor_result
end

#checks_summaryString

The Summary of all Checks.

Returns:

  • (String)


66
67
68
# File 'lib/oci/database_migration/models/assessor.rb', line 66

def checks_summary
  @checks_summary
end

#descriptionString

[Required] A user-friendly description. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String)


39
40
41
# File 'lib/oci/database_migration/models/assessor.rb', line 39

def description
  @description
end

#display_nameString

[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String)


33
34
35
# File 'lib/oci/database_migration/models/assessor.rb', line 33

def display_name
  @display_name
end

#does_script_require_restartBOOLEAN

True if DB restart required after running the script, false otherwise.

Returns:

  • (BOOLEAN)


80
81
82
# File 'lib/oci/database_migration/models/assessor.rb', line 80

def does_script_require_restart
  @does_script_require_restart
end

#has_scriptBOOLEAN

True if script is available either from 'script' property of through download, false otherwise.

Returns:

  • (BOOLEAN)


70
71
72
# File 'lib/oci/database_migration/models/assessor.rb', line 70

def has_script
  @has_script
end

[Required] The Help link text.

Returns:

  • (String)


47
48
49
# File 'lib/oci/database_migration/models/assessor.rb', line 47

def help_link_text
  @help_link_text
end

[Required] The Help URL.

Returns:

  • (String)


43
44
45
# File 'lib/oci/database_migration/models/assessor.rb', line 43

def help_link_url
  @help_link_url
end

#lifecycle_stateString

[Required] The current state of the Assessor.

Returns:

  • (String)


51
52
53
# File 'lib/oci/database_migration/models/assessor.rb', line 51

def lifecycle_state
  @lifecycle_state
end

#nameString

[Required] The Assessor Name.

Returns:

  • (String)


27
28
29
# File 'lib/oci/database_migration/models/assessor.rb', line 27

def name
  @name
end

#scriptString

The generated SQL script. Can be empty if the script exceeds maxLength. In this case the property 'hasScript' indicates that the script is available for download.

Returns:

  • (String)


76
77
78
# File 'lib/oci/database_migration/models/assessor.rb', line 76

def script
  @script
end

Class Method Details

.attribute_mapObject

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/oci/database_migration/models/assessor.rb', line 83

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'assessment_id': :'assessmentId',
    'name': :'name',
    'display_name': :'displayName',
    'description': :'description',
    'help_link_url': :'helpLinkUrl',
    'help_link_text': :'helpLinkText',
    'lifecycle_state': :'lifecycleState',
    'assessor_group': :'assessorGroup',
    'actions': :'actions',
    'assessor_result': :'assessorResult',
    'checks_summary': :'checksSummary',
    'has_script': :'hasScript',
    'script': :'script',
    'does_script_require_restart': :'doesScriptRequireRestart'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/oci/database_migration/models/assessor.rb', line 105

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'assessment_id': :'String',
    'name': :'String',
    'display_name': :'String',
    'description': :'String',
    'help_link_url': :'String',
    'help_link_text': :'String',
    'lifecycle_state': :'String',
    'assessor_group': :'OCI::DatabaseMigration::Models::AssessorGroup',
    'actions': :'Array<OCI::DatabaseMigration::Models::AssessorAction>',
    'assessor_result': :'String',
    'checks_summary': :'String',
    'has_script': :'BOOLEAN',
    'script': :'String',
    'does_script_require_restart': :'BOOLEAN'
    # 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



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# File 'lib/oci/database_migration/models/assessor.rb', line 242

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

  self.class == other.class &&
    assessment_id == other.assessment_id &&
    name == other.name &&
    display_name == other.display_name &&
    description == other.description &&
    help_link_url == other.help_link_url &&
    help_link_text == other.help_link_text &&
    lifecycle_state == other.lifecycle_state &&
    assessor_group == other.assessor_group &&
    actions == other.actions &&
    assessor_result == other.assessor_result &&
    checks_summary == other.checks_summary &&
    has_script == other.has_script &&
    script == other.script &&
    does_script_require_restart == other.does_script_require_restart
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



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

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


265
266
267
# File 'lib/oci/database_migration/models/assessor.rb', line 265

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



274
275
276
# File 'lib/oci/database_migration/models/assessor.rb', line 274

def hash
  [assessment_id, name, display_name, description, help_link_url, help_link_text, lifecycle_state, assessor_group, actions, assessor_result, checks_summary, has_script, script, does_script_require_restart].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



318
319
320
321
322
323
324
325
326
327
# File 'lib/oci/database_migration/models/assessor.rb', line 318

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



312
313
314
# File 'lib/oci/database_migration/models/assessor.rb', line 312

def to_s
  to_hash.to_s
end