Class: OCI::MediaServices::Models::SystemMediaWorkflow

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

Overview

A named list of tasks to be used to run a job or as a template to create a MediaWorkflow.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SystemMediaWorkflow

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/media_services/models/system_media_workflow.rb', line 69

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

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

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

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

Instance Attribute Details

#description ⇒ String

Description of this workflow's processing and how that processing can be customized by specifying parameter values.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/media_services/models/system_media_workflow.rb', line 19

def description
  @description
end

#name ⇒ String

[Required] System provided unique identifier for this static media workflow.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/media_services/models/system_media_workflow.rb', line 13

def name
  @name
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.

Returns:

  • (Hash<String, Object>) 


26
27
28
 
# File 'lib/oci/media_services/models/system_media_workflow.rb', line 26

def parameters
  @parameters
end

#tasks ⇒ Array<OCI::MediaServices::Models::MediaWorkflowTask>

[Required] 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.

Returns:



33
34
35
 
# File 'lib/oci/media_services/models/system_media_workflow.rb', line 33

def tasks
  @tasks
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/oci/media_services/models/system_media_workflow.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'parameters': :'parameters',
    'tasks': :'tasks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/media_services/models/system_media_workflow.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'parameters': :'Hash<String, Object>',
    'tasks': :'Array<OCI::MediaServices::Models::MediaWorkflowTask>'
    # 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



91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/media_services/models/system_media_workflow.rb', line 91

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

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    parameters == other.parameters &&
    tasks == other.tasks
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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/media_services/models/system_media_workflow.rb', line 124

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


104
105
106
 
# File 'lib/oci/media_services/models/system_media_workflow.rb', line 104

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



113
114
115
 
# File 'lib/oci/media_services/models/system_media_workflow.rb', line 113

def hash
  [name, description, parameters, tasks].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/media_services/models/system_media_workflow.rb', line 157

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



151
152
153
 
# File 'lib/oci/media_services/models/system_media_workflow.rb', line 151

def to_s
  to_hash.to_s
end