Class: OCI::DatabaseManagement::Models::OptimizerStatisticsAdvisorExecution

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

Overview

The summary of the Optimizer Statistics Advisor execution, which includes information about the Managed Database and a comprehensive execution report.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_EXECUTING = 'EXECUTING'.freeze,
  STATUS_COMPLETED = 'COMPLETED'.freeze,
  STATUS_INTERRUPTED = 'INTERRUPTED'.freeze,
  STATUS_CANCELLED = 'CANCELLED'.freeze,
  STATUS_FATAL_ERROR = 'FATAL_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 = {}) ⇒ OptimizerStatisticsAdvisorExecution

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



117
118
119
120
121
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
 
# File 'lib/oci/database_management/models/optimizer_statistics_advisor_execution.rb', line 117

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

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

  self.task_name = attributes[:'taskName'] if attributes[:'taskName']

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

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

  self.execution_name = attributes[:'executionName'] if attributes[:'executionName']

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

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

  self.time_start = attributes[:'timeStart'] if attributes[:'timeStart']

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

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

  self.time_end = attributes[:'timeEnd'] if attributes[:'timeEnd']

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

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

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

  self.status_message = attributes[:'statusMessage'] if attributes[:'statusMessage']

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

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

  self.error_message = attributes[:'errorMessage'] if attributes[:'errorMessage']

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

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

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

Instance Attribute Details

#database ⇒ OCI::DatabaseManagement::Models::OptimizerDatabase

Returns:



24
25
26
 
# File 'lib/oci/database_management/models/optimizer_statistics_advisor_execution.rb', line 24

def database
  @database
end

#error_message ⇒ String

The errors in the Optimizer Statistics Advisor execution, if any.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/database_management/models/optimizer_statistics_advisor_execution.rb', line 59

def error_message
  @error_message
end

#execution_name ⇒ String

[Required] The name of the Optimizer Statistics Advisor execution.

Returns:

  • (String) 


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

def execution_name
  @execution_name
end

#findings ⇒ Integer

The number of findings generated by the Optimizer Statistics Advisor execution.

Returns:

  • (Integer) 


63
64
65
 
# File 'lib/oci/database_management/models/optimizer_statistics_advisor_execution.rb', line 63

def findings
  @findings
end

#report ⇒ OCI::DatabaseManagement::Models::OptimizerStatisticsAdvisorExecutionReport

Returns:



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

def report
  @report
end

#status ⇒ String

[Required] The status of the Optimizer Statistics Advisor execution.

Returns:

  • (String) 


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

def status
  @status
end

#status_message ⇒ String

The Optimizer Statistics Advisor execution status message, if any.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/database_management/models/optimizer_statistics_advisor_execution.rb', line 55

def status_message
  @status_message
end

#task_name ⇒ String

[Required] The name of the Optimizer Statistics Advisor task.

Returns:

  • (String) 


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

def task_name
  @task_name
end

#time_end ⇒ DateTime

[Required] The end time of the time range to retrieve the Optimizer Statistics Advisor execution of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

Returns:

  • (DateTime) 


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

def time_end
  @time_end
end

#time_start ⇒ DateTime

[Required] The start time of the time range to retrieve the Optimizer Statistics Advisor execution of a Managed Database in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'".

Returns:

  • (DateTime) 


41
42
43
 
# File 'lib/oci/database_management/models/optimizer_statistics_advisor_execution.rb', line 41

def time_start
  @time_start
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/database_management/models/optimizer_statistics_advisor_execution.rb', line 66

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'database': :'database',
    'report': :'report',
    'task_name': :'taskName',
    'execution_name': :'executionName',
    'time_start': :'timeStart',
    'time_end': :'timeEnd',
    'status': :'status',
    'status_message': :'statusMessage',
    'error_message': :'errorMessage',
    'findings': :'findings'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/database_management/models/optimizer_statistics_advisor_execution.rb', line 84

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'database': :'OCI::DatabaseManagement::Models::OptimizerDatabase',
    'report': :'OCI::DatabaseManagement::Models::OptimizerStatisticsAdvisorExecutionReport',
    'task_name': :'String',
    'execution_name': :'String',
    'time_start': :'DateTime',
    'time_end': :'DateTime',
    'status': :'String',
    'status_message': :'String',
    'error_message': :'String',
    'findings': :'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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/database_management/models/optimizer_statistics_advisor_execution.rb', line 188

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

  self.class == other.class &&
    database == other.database &&
    report == other.report &&
    task_name == other.task_name &&
    execution_name == other.execution_name &&
    time_start == other.time_start &&
    time_end == other.time_end &&
    status == other.status &&
    status_message == other.status_message &&
    error_message == other.error_message &&
    findings == other.findings
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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oci/database_management/models/optimizer_statistics_advisor_execution.rb', line 227

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


207
208
209
 
# File 'lib/oci/database_management/models/optimizer_statistics_advisor_execution.rb', line 207

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



216
217
218
 
# File 'lib/oci/database_management/models/optimizer_statistics_advisor_execution.rb', line 216

def hash
  [database, report, task_name, execution_name, time_start, time_end, status, status_message, error_message, findings].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/database_management/models/optimizer_statistics_advisor_execution.rb', line 260

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



254
255
256
 
# File 'lib/oci/database_management/models/optimizer_statistics_advisor_execution.rb', line 254

def to_s
  to_hash.to_s
end