Class: OCI::AiAnomalyDetection::Models::DetectAnomalyJob

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb

Overview

Anomaly Job contains information for asynchronous detection of anomalies.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_PARTIALLY_SUCCEEDED = 'PARTIALLY_SUCCEEDED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.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 = {}) ⇒ DetectAnomalyJob

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 176

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

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

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

  self.project_id = attributes[:'projectId'] if attributes[:'projectId']

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

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

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

  self.are_all_estimates_required = attributes[:'areAllEstimatesRequired'] unless attributes[:'areAllEstimatesRequired'].nil?

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

  self.are_all_estimates_required = attributes[:'are_all_estimates_required'] unless attributes[:'are_all_estimates_required'].nil?

  self.input_details = attributes[:'inputDetails'] if attributes[:'inputDetails']

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

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

  self.output_details = attributes[:'outputDetails'] if attributes[:'outputDetails']

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

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

  self.time_accepted = attributes[:'timeAccepted'] if attributes[:'timeAccepted']

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

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

  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']

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

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

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

  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']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#are_all_estimates_required ⇒ BOOLEAN

Flag to enable the service to return estimates for all data points rather than just the anomalous data points

Returns:

  • (BOOLEAN) 


52
53
54
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 52

def are_all_estimates_required
  @are_all_estimates_required
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that starts the job.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 28

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


92
93
94
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 92

def defined_tags
  @defined_tags
end

#description ⇒ String

Detect anomaly job description.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 36

def description
  @description
end

#display_name ⇒ String

Detect anomaly job display name.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 32

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


86
87
88
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 86

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Id of the job.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 24

def id
  @id
end

#input_details ⇒ OCI::AiAnomalyDetection::Models::InputJobDetails

This attribute is required.

Returns:



56
57
58
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 56

def input_details
  @input_details
end

#lifecycle_state ⇒ String

[Required] The current state of the batch document job.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 76

def lifecycle_state
  @lifecycle_state
end

#lifecycle_state_details ⇒ String

The current state details of the batch document job.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 80

def lifecycle_state_details
  @lifecycle_state_details
end

#model_id ⇒ String

[Required] The OCID of the trained model.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 40

def model_id
  @model_id
end

#output_details ⇒ OCI::AiAnomalyDetection::Models::OutputJobDetails

This attribute is required.

Returns:



60
61
62
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 60

def output_details
  @output_details
end

#project_id ⇒ String

The OCID of the project.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 44

def project_id
  @project_id
end

#sensitivity ⇒ Float

The value that customer can adjust to control the sensitivity of anomaly detection

Returns:

  • (Float) 


48
49
50
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 48

def sensitivity
  @sensitivity
end

#system_tags ⇒ Hash<String, Object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }

Returns:

  • (Hash<String, Object>) 


98
99
100
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 98

def system_tags
  @system_tags
end

#time_accepted ⇒ DateTime

[Required] Job accepted time

Returns:

  • (DateTime) 


64
65
66
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 64

def time_accepted
  @time_accepted
end

#time_finished ⇒ DateTime

Job finished time

Returns:

  • (DateTime) 


72
73
74
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 72

def time_finished
  @time_finished
end

#time_started ⇒ DateTime

Job started time

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 68

def time_started
  @time_started
end

Class Method Details

.attribute_map ⇒ Object

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 101

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'model_id': :'modelId',
    'project_id': :'projectId',
    'sensitivity': :'sensitivity',
    'are_all_estimates_required': :'areAllEstimatesRequired',
    'input_details': :'inputDetails',
    'output_details': :'outputDetails',
    'time_accepted': :'timeAccepted',
    'time_started': :'timeStarted',
    'time_finished': :'timeFinished',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_state_details': :'lifecycleStateDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 127

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'model_id': :'String',
    'project_id': :'String',
    'sensitivity': :'Float',
    'are_all_estimates_required': :'BOOLEAN',
    'input_details': :'OCI::AiAnomalyDetection::Models::InputJobDetails',
    'output_details': :'OCI::AiAnomalyDetection::Models::OutputJobDetails',
    'time_accepted': :'DateTime',
    'time_started': :'DateTime',
    'time_finished': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_state_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'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



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 299

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    model_id == other.model_id &&
    project_id == other.project_id &&
    sensitivity == other.sensitivity &&
    are_all_estimates_required == other.are_all_estimates_required &&
    input_details == other.input_details &&
    output_details == other.output_details &&
    time_accepted == other.time_accepted &&
    time_started == other.time_started &&
    time_finished == other.time_finished &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_state_details == other.lifecycle_state_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 346

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


326
327
328
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 326

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



335
336
337
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 335

def hash
  [id, compartment_id, display_name, description, model_id, project_id, sensitivity, are_all_estimates_required, input_details, output_details, time_accepted, time_started, time_finished, lifecycle_state, lifecycle_state_details, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



379
380
381
382
383
384
385
386
387
388
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 379

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



373
374
375
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomaly_job.rb', line 373

def to_s
  to_hash.to_s
end