Class: OCI::MediaServices::Models::MediaWorkflowJob

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/media_services/models/media_workflow_job.rb

Overview

A MediaWorkflowJob represents a run of a MediaWorkflow for a specific set of parameters and configurations.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_WAITING = 'WAITING'.freeze,
  LIFECYCLE_STATE_REJECTED = 'REJECTED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_CANCELING = 'CANCELING'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.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 = {}) ⇒ MediaWorkflowJob

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 193

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

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

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

  self.media_workflow_id = attributes[:'mediaWorkflowId'] if attributes[:'mediaWorkflowId']

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

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

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

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

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

  self.task_lifecycle_state = attributes[:'taskLifecycleState'] if attributes[:'taskLifecycleState']

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

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

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

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

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

  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_ended = attributes[:'timeEnded'] if attributes[:'timeEnded']

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

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

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

  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

#compartment_id ⇒ String

[Required] Compartment Identifier.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 39

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


106
107
108
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 106

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Name of the Media Workflow Job. Does not have to be unique. Avoid entering confidential information.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 43

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


100
101
102
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 100

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier for this run of the workflow.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 35

def id
  @id
end

#lifecycle_details ⇒ String

The lifecyle details.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 51

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the MediaWorkflowJob.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 47

def lifecycle_state
  @lifecycle_state
end

#locks ⇒ Array<OCI::MediaServices::Models::ResourceLock>

Locks associated with this resource.

Returns:



94
95
96
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 94

def locks
  @locks
end

#media_workflow_configuration_ids ⇒ Array<String>

Configurations to be applied to this run of the workflow.

Returns:

  • (Array<String>) 


27
28
29
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 27

def media_workflow_configuration_ids
  @media_workflow_configuration_ids
end

#media_workflow_id ⇒ String

[Required] The workflow to execute.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 31

def media_workflow_id
  @media_workflow_id
end

#outputs ⇒ Array<OCI::MediaServices::Models::JobOutput>

A list of JobOutput for the workflowJob.

Returns:



82
83
84
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 82

def outputs
  @outputs
end

#parameters ⇒ Hash<String, Object>

Parameters that override parameters specified in MediaWorkflowTaskDeclarations, the MediaWorkflow, the MediaWorkflow's MediaWorkflowConfigurations and the MediaWorkflowConfigurations of this MediaWorkflowJob. The parameters are given as JSON. The top level and 2nd level elements must be JSON objects (vs arrays, scalars, etc). The top level keys refer to a task's key and the 2nd level keys refer to a parameter's name.

Returns:

  • (Hash<String, Object>) 


64
65
66
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 64

def parameters
  @parameters
end

#runnable ⇒ Hash<String, Object>

A JSON representation of the job as it will be run by the system. All the task declarations, configurations and parameters are merged. Parameter values are all fully resolved.

Returns:

  • (Hash<String, Object>) 


78
79
80
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 78

def runnable
  @runnable
end

#system_tags ⇒ Hash<String, 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, Hash<String, Object>>) 


112
113
114
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 112

def system_tags
  @system_tags
end

#task_lifecycle_state ⇒ Array<OCI::MediaServices::Models::MediaWorkflowTaskState>

Status of each task.

Returns:



55
56
57
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 55

def task_lifecycle_state
  @task_lifecycle_state
end

#time_created ⇒ DateTime

Creation time of the job. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 68

def time_created
  @time_created
end

#time_ended ⇒ DateTime

Time when the job finished. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


90
91
92
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 90

def time_ended
  @time_ended
end

#time_started ⇒ DateTime

Time when the job started to execute. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


86
87
88
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 86

def time_started
  @time_started
end

#time_updated ⇒ DateTime

Updated time of the job. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


72
73
74
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 72

def time_updated
  @time_updated
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
137
138
139
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 115

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'media_workflow_configuration_ids': :'mediaWorkflowConfigurationIds',
    'media_workflow_id': :'mediaWorkflowId',
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'task_lifecycle_state': :'taskLifecycleState',
    'parameters': :'parameters',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'runnable': :'runnable',
    'outputs': :'outputs',
    'time_started': :'timeStarted',
    'time_ended': :'timeEnded',
    'locks': :'locks',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/media_services/models/media_workflow_job.rb', line 142

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'media_workflow_configuration_ids': :'Array<String>',
    'media_workflow_id': :'String',
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'task_lifecycle_state': :'Array<OCI::MediaServices::Models::MediaWorkflowTaskState>',
    'parameters': :'Hash<String, Object>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'runnable': :'Hash<String, Object>',
    'outputs': :'Array<OCI::MediaServices::Models::JobOutput>',
    'time_started': :'DateTime',
    'time_ended': :'DateTime',
    'locks': :'Array<OCI::MediaServices::Models::ResourceLock>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 314

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

  self.class == other.class &&
    media_workflow_configuration_ids == other.media_workflow_configuration_ids &&
    media_workflow_id == other.media_workflow_id &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    task_lifecycle_state == other.task_lifecycle_state &&
    parameters == other.parameters &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    runnable == other.runnable &&
    outputs == other.outputs &&
    time_started == other.time_started &&
    time_ended == other.time_ended &&
    locks == other.locks &&
    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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 362

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


342
343
344
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 342

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



351
352
353
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 351

def hash
  [media_workflow_configuration_ids, media_workflow_id, id, compartment_id, display_name, lifecycle_state, lifecycle_details, task_lifecycle_state, parameters, time_created, time_updated, runnable, outputs, time_started, time_ended, locks, 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



395
396
397
398
399
400
401
402
403
404
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 395

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



389
390
391
 
# File 'lib/oci/media_services/models/media_workflow_job.rb', line 389

def to_s
  to_hash.to_s
end