Class: OCI::LogAnalytics::Models::ScheduledTaskSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/models/scheduled_task_summary.rb

Overview

Summary information about a scheduled task.

Constant Summary collapse

TASK_TYPE_ENUM = 
[
  TASK_TYPE_SAVED_SEARCH = 'SAVED_SEARCH'.freeze,
  TASK_TYPE_ACCELERATION = 'ACCELERATION'.freeze,
  TASK_TYPE_PURGE = 'PURGE'.freeze,
  TASK_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
TASK_STATUS_ENUM = 
[
  TASK_STATUS_READY = 'READY'.freeze,
  TASK_STATUS_PAUSED = 'PAUSED'.freeze,
  TASK_STATUS_COMPLETED = 'COMPLETED'.freeze,
  TASK_STATUS_BLOCKED = 'BLOCKED'.freeze,
  TASK_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LAST_EXECUTION_STATUS_ENUM = 
[
  LAST_EXECUTION_STATUS_FAILED = 'FAILED'.freeze,
  LAST_EXECUTION_STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  LAST_EXECUTION_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SCHEDULE_TYPE_ENUM = 
[
  SCHEDULE_TYPE_FIXED_FREQUENCY = 'FIXED_FREQUENCY'.freeze,
  SCHEDULE_TYPE_CRON = 'CRON'.freeze,
  SCHEDULE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScheduledTaskSummary

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

  • :task_type (String) —

    The value to assign to the #task_type property

  • :target_service (String) —

    The value to assign to the #target_service property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :task_status (String) —

    The value to assign to the #task_status property

  • :pause_reason (String) —

    The value to assign to the #pause_reason property

  • :work_request_id (String) —

    The value to assign to the #work_request_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :last_execution_status (String) —

    The value to assign to the #last_execution_status property

  • :time_last_executed (DateTime) —

    The value to assign to the #time_last_executed property

  • :schedule_type (String) —

    The value to assign to the #schedule_type property



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
278
279
280
281
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 184

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

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

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

  self.target_service = attributes[:'targetService'] if attributes[:'targetService']

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

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

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

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

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

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

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

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

  self.pause_reason = attributes[:'pauseReason'] if attributes[:'pauseReason']

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

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

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

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

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

  self.time_last_executed = attributes[:'timeLastExecuted'] if attributes[:'timeLastExecuted']

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

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

  self.schedule_type = attributes[:'scheduleType'] if attributes[:'scheduleType']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Compartment Identifier [OCID] (docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 54

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>>) 


100
101
102
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 100

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 88

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>) 


94
95
96
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 94

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the data plane resource.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 42

def id
  @id
end

#last_execution_status ⇒ String

The most recent task execution status.

Returns:

  • (String) 


104
105
106
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 104

def last_execution_status
  @last_execution_status
end

#lifecycle_state ⇒ String

[Required] The current state of the scheduled task.

Returns:

  • (String) 


68
69
70
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 68

def lifecycle_state
  @lifecycle_state
end

#pause_reason ⇒ String

reason for taskStatus PAUSED.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 76

def pause_reason
  @pause_reason
end

#schedule_type ⇒ String

Type of the task schedule

Returns:

  • (String) 


112
113
114
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 112

def schedule_type
  @schedule_type
end

#target_service ⇒ String

Target Service

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 50

def target_service
  @target_service
end

#task_status ⇒ String

Status of the scheduled task.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 72

def task_status
  @task_status
end

#task_type ⇒ String

[Required] Task type.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 46

def task_type
  @task_type
end

#time_created ⇒ DateTime

[Required] The date and time the schedule task was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


59
60
61
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 59

def time_created
  @time_created
end

#time_last_executed ⇒ DateTime

The date and time the scheduled task last executed, in the format defined by RFC3339.

Returns:

  • (DateTime) 


108
109
110
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 108

def time_last_executed
  @time_last_executed
end

#time_updated ⇒ DateTime

[Required] The date and time the scheduled task was last updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


64
65
66
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 64

def time_updated
  @time_updated
end

#work_request_id ⇒ String

most recent Work Request Identifier [OCID] (docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 80

def work_request_id
  @work_request_id
end

Class Method Details

.attribute_map ⇒ Object

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



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 115

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'task_type': :'taskType',
    'target_service': :'targetService',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'task_status': :'taskStatus',
    'pause_reason': :'pauseReason',
    'work_request_id': :'workRequestId',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'last_execution_status': :'lastExecutionStatus',
    'time_last_executed': :'timeLastExecuted',
    'schedule_type': :'scheduleType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 139

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'task_type': :'String',
    'target_service': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'task_status': :'String',
    'pause_reason': :'String',
    'work_request_id': :'String',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'last_execution_status': :'String',
    'time_last_executed': :'DateTime',
    'schedule_type': :'String'
    # 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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 342

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

  self.class == other.class &&
    id == other.id &&
    task_type == other.task_type &&
    target_service == other.target_service &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    task_status == other.task_status &&
    pause_reason == other.pause_reason &&
    work_request_id == other.work_request_id &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    last_execution_status == other.last_execution_status &&
    time_last_executed == other.time_last_executed &&
    schedule_type == other.schedule_type
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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 387

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


367
368
369
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 367

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



376
377
378
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 376

def hash
  [id, task_type, target_service, compartment_id, time_created, time_updated, lifecycle_state, task_status, pause_reason, work_request_id, display_name, freeform_tags, defined_tags, last_execution_status, time_last_executed, schedule_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



420
421
422
423
424
425
426
427
428
429
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 420

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



414
415
416
 
# File 'lib/oci/log_analytics/models/scheduled_task_summary.rb', line 414

def to_s
  to_hash.to_s
end