Class: OCI::DatabaseManagement::Models::SqlTuningAdvisorTaskSummaryReportTaskInfo

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb

Overview

The general information regarding the SQL Tuning Advisor task.

Constant Summary collapse

STATUS_ENUM =
[
  STATUS_COMPLETED = 'COMPLETED'.freeze,
  STATUS_INITIAL = 'INITIAL'.freeze,
  STATUS_EXECUTING = 'EXECUTING'.freeze,
  STATUS_INTERRUPTED = 'INTERRUPTED'.freeze,
  STATUS_ERROR = 'ERROR'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SqlTuningAdvisorTaskSummaryReportTaskInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (Integer)

    The value to assign to the #id property

  • :name (String)

    The value to assign to the #name property

  • :description (String)

    The value to assign to the #description property

  • :owner (String)

    The value to assign to the #owner property

  • :status (String)

    The value to assign to the #status property

  • :time_started (DateTime)

    The value to assign to the #time_started property

  • :time_ended (DateTime)

    The value to assign to the #time_ended property

  • :running_time (Integer)

    The value to assign to the #running_time property



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 99

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

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

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

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

  self.time_started = attributes[:'timeStarted'] if attributes[:'timeStarted']

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

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

  self.time_ended = attributes[:'timeEnded'] if attributes[:'timeEnded']

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

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

  self.running_time = attributes[:'runningTime'] if attributes[:'runningTime']

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

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

Instance Attribute Details

#descriptionString

The description of the SQL Tuning Advisor task. This is not defined for Auto SQL Tuning tasks.

Returns:

  • (String)


31
32
33
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 31

def description
  @description
end

#idInteger

[Required] The ID of the SQL Tuning Advisor task. This is not the OCID.

Returns:

  • (Integer)


23
24
25
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 23

def id
  @id
end

#nameString

[Required] The name of the SQL Tuning Advisor task.

Returns:

  • (String)


27
28
29
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 27

def name
  @name
end

#ownerString

[Required] The owner of the SQL Tuning Advisor task.

Returns:

  • (String)


35
36
37
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 35

def owner
  @owner
end

#running_timeInteger

The total running time in seconds. This is not defined for Auto SQL Tuning tasks.

Returns:

  • (Integer)


51
52
53
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 51

def running_time
  @running_time
end

#statusString

The status of the SQL Tuning Advisor task. This is not defined for Auto SQL Tuning tasks.

Returns:

  • (String)


39
40
41
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 39

def status
  @status
end

#time_endedDateTime

[Required] The end time of the task execution.

Returns:

  • (DateTime)


47
48
49
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 47

def time_ended
  @time_ended
end

#time_startedDateTime

[Required] The start time of the task execution.

Returns:

  • (DateTime)


43
44
45
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 43

def time_started
  @time_started
end

Class Method Details

.attribute_mapObject

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 54

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'description': :'description',
    'owner': :'owner',
    'status': :'status',
    'time_started': :'timeStarted',
    'time_ended': :'timeEnded',
    'running_time': :'runningTime'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 70

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'Integer',
    'name': :'String',
    'description': :'String',
    'owner': :'String',
    'status': :'String',
    'time_started': :'DateTime',
    'time_ended': :'DateTime',
    'running_time': :'Integer'
    # 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



154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 154

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    description == other.description &&
    owner == other.owner &&
    status == other.status &&
    time_started == other.time_started &&
    time_ended == other.time_ended &&
    running_time == other.running_time
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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 191

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


171
172
173
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 171

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



180
181
182
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 180

def hash
  [id, name, description, owner, status, time_started, time_ended, running_time].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



224
225
226
227
228
229
230
231
232
233
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 224

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



218
219
220
# File 'lib/oci/database_management/models/sql_tuning_advisor_task_summary_report_task_info.rb', line 218

def to_s
  to_hash.to_s
end