Class: OCI::Jms::Models::PerformanceTuningAnalysisResultSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/jms/models/performance_tuning_analysis_result_summary.rb

Overview

Summary of a performance tuning analysis result. The actual output of the analysis is stored in the Object Storage object.

Constant Summary collapse

RESULT_ENUM = 
[
  RESULT_ACTION_RECOMMENDED = 'ACTION_RECOMMENDED'.freeze,
  RESULT_NO_WARNINGS = 'NO_WARNINGS'.freeze,
  RESULT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PerformanceTuningAnalysisResultSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :work_request_id (String) —

    The value to assign to the #work_request_id property

  • :fleet_id (String) —

    The value to assign to the #fleet_id property

  • :application_id (String) —

    The value to assign to the #application_id property

  • :application_installation_id (String) —

    The value to assign to the #application_installation_id property

  • :application_installation_path (String) —

    The value to assign to the #application_installation_path property

  • :warning_count (Integer) —

    The value to assign to the #warning_count property

  • :result (String) —

    The value to assign to the #result property

  • :managed_instance_id (String) —

    The value to assign to the #managed_instance_id property

  • :host_name (String) —

    The value to assign to the #host_name property

  • :application_name (String) —

    The value to assign to the #application_name property

  • :namespace (String) —

    The value to assign to the #namespace property

  • :bucket_name (String) —

    The value to assign to the #bucket_name property

  • :object_name (String) —

    The value to assign to the #object_name property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_started (DateTime) —

    The value to assign to the #time_started property

  • :time_finished (DateTime) —

    The value to assign to the #time_finished property



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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 159

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

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

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

  self.fleet_id = attributes[:'fleetId'] if attributes[:'fleetId']

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

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

  self.application_id = attributes[:'applicationId'] if attributes[:'applicationId']

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

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

  self.application_installation_id = attributes[:'applicationInstallationId'] if attributes[:'applicationInstallationId']

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

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

  self.application_installation_path = attributes[:'applicationInstallationPath'] if attributes[:'applicationInstallationPath']

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

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

  self.warning_count = attributes[:'warningCount'] if attributes[:'warningCount']

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

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

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

  self.managed_instance_id = attributes[:'managedInstanceId'] if attributes[:'managedInstanceId']

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

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

  self.host_name = attributes[:'hostName'] if attributes[:'hostName']

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

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

  self.application_name = attributes[:'applicationName'] if attributes[:'applicationName']

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

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

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

  self.bucket_name = attributes[:'bucketName'] if attributes[:'bucketName']

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

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

  self.object_name = attributes[:'objectName'] if attributes[:'objectName']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  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_finished = attributes[:'timeFinished'] if attributes[:'timeFinished']

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

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

Instance Attribute Details

#application_id ⇒ String

[Required] The OCID of the application for which the report has been generated.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 32

def application_id
  @application_id
end

#application_installation_id ⇒ String

[Required] The internal identifier of the application installation for which the report has been generated.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 36

def application_installation_id
  @application_installation_id
end

#application_installation_path ⇒ String

[Required] The installation path of the application for which the report has been generated.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 40

def application_installation_path
  @application_installation_path
end

#application_name ⇒ String

[Required] The name of the application for which the report has been generated.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 60

def application_name
  @application_name
end

#bucket_name ⇒ String

[Required] The Object Storage bucket name of this analysis result.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 68

def bucket_name
  @bucket_name
end

#fleet_id ⇒ String

[Required] The fleet OCID.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 28

def fleet_id
  @fleet_id
end

#host_name ⇒ String

[Required] The hostname of the managed instance.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 56

def host_name
  @host_name
end

#id ⇒ String

[Required] The OCID to identify this analysis results.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 20

def id
  @id
end

#managed_instance_id ⇒ String

[Required] The managed instance OCID.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 52

def managed_instance_id
  @managed_instance_id
end

#namespace ⇒ String

[Required] The Object Storage namespace of this analysis result.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 64

def namespace
  @namespace
end

#object_name ⇒ String

[Required] The Object Storage object name of this analysis result.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 72

def object_name
  @object_name
end

#result ⇒ String

[Required] Result of the analysis based on whether warnings have been found or not.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 48

def result
  @result
end

#time_created ⇒ DateTime

[Required] The time the result is compiled.

Returns:

  • (DateTime) 


76
77
78
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 76

def time_created
  @time_created
end

#time_finished ⇒ DateTime

[Required] The time the JFR capture finished.

Returns:

  • (DateTime) 


84
85
86
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 84

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

[Required] The time the JFR capture started.

Returns:

  • (DateTime) 


80
81
82
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 80

def time_started
  @time_started
end

#warning_count ⇒ Integer

[Required] Total number of warnings reported by the analysis.

Returns:

  • (Integer) 


44
45
46
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 44

def warning_count
  @warning_count
end

#work_request_id ⇒ String

The OCID of the work request to start the analysis.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 24

def work_request_id
  @work_request_id
end

Class Method Details

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 87

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'work_request_id': :'workRequestId',
    'fleet_id': :'fleetId',
    'application_id': :'applicationId',
    'application_installation_id': :'applicationInstallationId',
    'application_installation_path': :'applicationInstallationPath',
    'warning_count': :'warningCount',
    'result': :'result',
    'managed_instance_id': :'managedInstanceId',
    'host_name': :'hostName',
    'application_name': :'applicationName',
    'namespace': :'namespace',
    'bucket_name': :'bucketName',
    'object_name': :'objectName',
    'time_created': :'timeCreated',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 112

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'work_request_id': :'String',
    'fleet_id': :'String',
    'application_id': :'String',
    'application_installation_id': :'String',
    'application_installation_path': :'String',
    'warning_count': :'Integer',
    'result': :'String',
    'managed_instance_id': :'String',
    'host_name': :'String',
    'application_name': :'String',
    'namespace': :'String',
    'bucket_name': :'String',
    'object_name': :'String',
    'time_created': :'DateTime',
    'time_started': :'DateTime',
    'time_finished': :'DateTime'
    # 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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 276

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

  self.class == other.class &&
    id == other.id &&
    work_request_id == other.work_request_id &&
    fleet_id == other.fleet_id &&
    application_id == other.application_id &&
    application_installation_id == other.application_installation_id &&
    application_installation_path == other.application_installation_path &&
    warning_count == other.warning_count &&
    result == other.result &&
    managed_instance_id == other.managed_instance_id &&
    host_name == other.host_name &&
    application_name == other.application_name &&
    namespace == other.namespace &&
    bucket_name == other.bucket_name &&
    object_name == other.object_name &&
    time_created == other.time_created &&
    time_started == other.time_started &&
    time_finished == other.time_finished
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



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 322

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


302
303
304
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 302

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



311
312
313
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 311

def hash
  [id, work_request_id, fleet_id, application_id, application_installation_id, application_installation_path, warning_count, result, managed_instance_id, host_name, application_name, namespace, bucket_name, object_name, time_created, time_started, time_finished].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



355
356
357
358
359
360
361
362
363
364
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 355

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



349
350
351
 
# File 'lib/oci/jms/models/performance_tuning_analysis_result_summary.rb', line 349

def to_s
  to_hash.to_s
end