Class: OCI::MediaServices::Models::MediaWorkflow
- Inherits:
-
Object
- Object
- OCI::MediaServices::Models::MediaWorkflow
- Defined in:
- lib/oci/media_services/models/media_workflow.rb
Overview
Configurable workflows that define the series of tasks that will be used to process video files.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] Compartment Identifier.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] Name of the Media Workflow.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] Unique identifier that is immutable on creation.
-
#lifecycle_state ⇒ String
The current state of the MediaWorkflow.
-
#lifecyle_details ⇒ String
A message describing the current state in more detail.
-
#media_workflow_configuration_ids ⇒ Array<String>
Configurations to be applied to all the runs of this workflow.
-
#parameters ⇒ Hash<String, Object>
JSON object representing named parameters and their default values that can be referenced throughout this workflow.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys.
-
#tasks ⇒ Array<OCI::MediaServices::Models::MediaWorkflowTask>
The processing to be done in this workflow.
-
#time_created ⇒ DateTime
The time when the MediaWorkflow was created.
-
#time_updated ⇒ DateTime
The time when the MediaWorkflow was updated.
-
#version ⇒ Integer
The version of the MediaWorkflow.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ MediaWorkflow
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ MediaWorkflow
Initializes the object
155 156 157 158 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 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 155 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.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.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.tasks = attributes[:'tasks'] if attributes[:'tasks'] 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.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.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.lifecyle_details = attributes[:'lifecyleDetails'] if attributes[:'lifecyleDetails'] raise 'You cannot provide both :lifecyleDetails and :lifecyle_details' if attributes.key?(:'lifecyleDetails') && attributes.key?(:'lifecyle_details') self.lifecyle_details = attributes[:'lifecyle_details'] if attributes[:'lifecyle_details'] self.version = attributes[:'version'] if attributes[:'version'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = attributes[:'system_tags'] if attributes[:'system_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] Compartment Identifier.
29 30 31 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 29 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\"}}
83 84 85 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 83 def @defined_tags end |
#display_name ⇒ String
[Required] Name of the Media Workflow. Does not have to be unique, and it's changeable. Avoid entering confidential information.
25 26 27 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 25 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\"}
77 78 79 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 77 def @freeform_tags end |
#id ⇒ String
[Required] Unique identifier that is immutable on creation.
21 22 23 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 21 def id @id end |
#lifecycle_state ⇒ String
The current state of the MediaWorkflow.
63 64 65 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 63 def lifecycle_state @lifecycle_state end |
#lifecyle_details ⇒ String
A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
67 68 69 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 67 def lifecyle_details @lifecyle_details end |
#media_workflow_configuration_ids ⇒ Array<String>
Configurations to be applied to all the runs of this workflow. Parameters in these configurations are overridden by parameters in the MediaWorkflowConfigurations of the MediaWorkflowJob and the parameters of the MediaWorkflowJob. If the same parameter appears in multiple configurations, the values that appear in the configuration at the highest index will be used.
44 45 46 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 44 def media_workflow_configuration_ids @media_workflow_configuration_ids end |
#parameters ⇒ Hash<String, Object>
JSON object representing named parameters and their default values that can be referenced throughout this workflow. The values declared here can be overridden by the MediaWorkflowConfigurations or parameters supplied when creating MediaWorkflowJobs from this MediaWorkflow.
51 52 53 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 51 def parameters @parameters 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\"}}
89 90 91 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 89 def @system_tags end |
#tasks ⇒ Array<OCI::MediaServices::Models::MediaWorkflowTask>
The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array is unique within the array. The order of the items is preserved from the order of the tasks array in CreateMediaWorkflowDetails or UpdateMediaWorkflowDetails.
36 37 38 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 36 def tasks @tasks end |
#time_created ⇒ DateTime
The time when the MediaWorkflow was created. An RFC3339 formatted datetime string.
55 56 57 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 55 def time_created @time_created end |
#time_updated ⇒ DateTime
The time when the MediaWorkflow was updated. An RFC3339 formatted datetime string.
59 60 61 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 59 def time_updated @time_updated end |
#version ⇒ Integer
The version of the MediaWorkflow.
71 72 73 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 71 def version @version end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 92 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'tasks': :'tasks', 'media_workflow_configuration_ids': :'mediaWorkflowConfigurationIds', 'parameters': :'parameters', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'lifecycle_state': :'lifecycleState', 'lifecyle_details': :'lifecyleDetails', 'version': :'version', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 114 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'display_name': :'String', 'compartment_id': :'String', 'tasks': :'Array<OCI::MediaServices::Models::MediaWorkflowTask>', 'media_workflow_configuration_ids': :'Array<String>', 'parameters': :'Hash<String, Object>', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'lifecycle_state': :'String', 'lifecyle_details': :'String', 'version': :'Integer', '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.
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 250 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && display_name == other.display_name && compartment_id == other.compartment_id && tasks == other.tasks && media_workflow_configuration_ids == other.media_workflow_configuration_ids && parameters == other.parameters && time_created == other.time_created && time_updated == other.time_updated && lifecycle_state == other.lifecycle_state && lifecyle_details == other.lifecyle_details && version == other.version && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 293 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
273 274 275 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 273 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
282 283 284 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 282 def hash [id, display_name, compartment_id, tasks, media_workflow_configuration_ids, parameters, time_created, time_updated, lifecycle_state, lifecyle_details, version, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
326 327 328 329 330 331 332 333 334 335 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 326 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
320 321 322 |
# File 'lib/oci/media_services/models/media_workflow.rb', line 320 def to_s to_hash.to_s end |