Class: OCI::LogAnalytics::Models::ScheduledTask

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

Overview

Log analytics scheduled task resource.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

StandardTask

Constant Summary collapse

KIND_ENUM = 
[
  KIND_ACCELERATION = 'ACCELERATION'.freeze,
  KIND_STANDARD = 'STANDARD'.freeze,
  KIND_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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
PAUSE_REASON_ENUM = 
[
  PAUSE_REASON_METRIC_EXTRACTION_NOT_VALID = 'METRIC_EXTRACTION_NOT_VALID'.freeze,
  PAUSE_REASON_SAVED_SEARCH_NOT_VALID = 'SAVED_SEARCH_NOT_VALID'.freeze,
  PAUSE_REASON_SAVED_SEARCH_NOT_FOUND = 'SAVED_SEARCH_NOT_FOUND'.freeze,
  PAUSE_REASON_QUERY_STRING_NOT_VALID = 'QUERY_STRING_NOT_VALID'.freeze,
  PAUSE_REASON_USER_ACTION = 'USER_ACTION'.freeze,
  PAUSE_REASON_TENANCY_LIFECYCLE = 'TENANCY_LIFECYCLE'.freeze,
  PAUSE_REASON_PURGE_RESOURCE_NOT_FOUND = 'PURGE_RESOURCE_NOT_FOUND'.freeze,
  PAUSE_REASON_LIMIT_EXCEEDED = 'LIMIT_EXCEEDED'.freeze,
  PAUSE_REASON_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ ScheduledTask

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :kind (String) —

    The value to assign to the #kind property

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :task_type (String) —

    The value to assign to the #task_type property

  • :schedules (Array<OCI::LogAnalytics::Models::Schedule>) —

    The value to assign to the #schedules property

  • :action (OCI::LogAnalytics::Models::Action) —

    The value to assign to the #action 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

  • :num_occurrences (Integer) —

    The value to assign to the #num_occurrences 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

  • :time_of_next_execution (DateTime) —

    The value to assign to the #time_of_next_execution property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state 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



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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 230

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#action ⇒ OCI::LogAnalytics::Models::Action

This attribute is required.

Returns:



85
86
87
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 85

def action
  @action
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


105
106
107
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 105

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


137
138
139
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 137

def defined_tags
  @defined_tags
end

#description ⇒ String

Description for this resource.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 73

def description
  @description
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) 


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

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


131
132
133
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 131

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the data plane resource.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 60

def id
  @id
end

#kind ⇒ String

[Required] Discriminator.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 55

def kind
  @kind
end

#lifecycle_state ⇒ String

[Required] The current state of the scheduled task.

Returns:

  • (String) 


125
126
127
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 125

def lifecycle_state
  @lifecycle_state
end

#num_occurrences ⇒ Integer

Number of execution occurrences.

Returns:

  • (Integer) 


101
102
103
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 101

def num_occurrences
  @num_occurrences
end

#pause_reason ⇒ String

reason for taskStatus PAUSED.

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 93

def pause_reason
  @pause_reason
end

#schedules ⇒ Array<OCI::LogAnalytics::Models::Schedule>

[Required] Schedules.

Returns:



81
82
83
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 81

def schedules
  @schedules
end

#task_status ⇒ String

Status of the scheduled task.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 89

def task_status
  @task_status
end

#task_type ⇒ String

[Required] Task type.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 77

def task_type
  @task_type
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


110
111
112
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 110

def time_created
  @time_created
end

#time_of_next_execution ⇒ DateTime

The date and time the scheduled task will execute next, in the format defined by RFC3339.

Returns:

  • (DateTime) 


121
122
123
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 121

def time_of_next_execution
  @time_of_next_execution
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


115
116
117
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 115

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) 


97
98
99
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 97

def work_request_id
  @work_request_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'kind': :'kind',
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'task_type': :'taskType',
    'schedules': :'schedules',
    'action': :'action',
    'task_status': :'taskStatus',
    'pause_reason': :'pauseReason',
    'work_request_id': :'workRequestId',
    'num_occurrences': :'numOccurrences',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'time_of_next_execution': :'timeOfNextExecution',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



196
197
198
199
200
201
202
203
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 196

def self.get_subtype(object_hash)
  type = object_hash[:'kind'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::LogAnalytics::Models::StandardTask' if type == 'STANDARD'

  # TODO: Log a warning when the subtype is not found.
  'OCI::LogAnalytics::Models::ScheduledTask'
end

.swagger_types ⇒ Object

Attribute type mapping.



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 166

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'kind': :'String',
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'task_type': :'String',
    'schedules': :'Array<OCI::LogAnalytics::Models::Schedule>',
    'action': :'OCI::LogAnalytics::Models::Action',
    'task_status': :'String',
    'pause_reason': :'String',
    'work_request_id': :'String',
    'num_occurrences': :'Integer',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_of_next_execution': :'DateTime',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, 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



397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 397

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

  self.class == other.class &&
    kind == other.kind &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    task_type == other.task_type &&
    schedules == other.schedules &&
    action == other.action &&
    task_status == other.task_status &&
    pause_reason == other.pause_reason &&
    work_request_id == other.work_request_id &&
    num_occurrences == other.num_occurrences &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    time_of_next_execution == other.time_of_next_execution &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 444

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


424
425
426
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 424

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



433
434
435
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 433

def hash
  [kind, id, display_name, description, task_type, schedules, action, task_status, pause_reason, work_request_id, num_occurrences, compartment_id, time_created, time_updated, time_of_next_execution, lifecycle_state, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



477
478
479
480
481
482
483
484
485
486
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 477

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



471
472
473
 
# File 'lib/oci/log_analytics/models/scheduled_task.rb', line 471

def to_s
  to_hash.to_s
end