Class: OCI::MediaServices::Models::MediaWorkflowTaskDeclaration

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

Overview

The declaration of a type of task that can be used in a MediaWorkflow.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MediaWorkflowTaskDeclaration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/media_services/models/media_workflow_task_declaration.rb', line 76

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

  self.parameters_schema = attributes[:'parametersSchema'] if attributes[:'parametersSchema']

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

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

  self.parameters_schema_allowing_references = attributes[:'parametersSchemaAllowingReferences'] if attributes[:'parametersSchemaAllowingReferences']

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

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

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

Instance Attribute Details

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

Locks associated with this resource.

Returns:



37
38
39
 
# File 'lib/oci/media_services/models/media_workflow_task_declaration.rb', line 37

def locks
  @locks
end

#name ⇒ String

[Required] MediaWorkflowTaskDeclaration identifier. The name and version should be unique among MediaWorkflowTaskDeclarations.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/media_services/models/media_workflow_task_declaration.rb', line 15

def name
  @name
end

#parameters_schema ⇒ Hash<String, Object>

[Required] JSON schema specifying the parameters supported by this type of task. This is used to validate tasks' parameters when jobs are created.

Returns:

  • (Hash<String, Object>) 


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

def parameters_schema
  @parameters_schema
end

#parameters_schema_allowing_references ⇒ Hash<String, Object>

[Required] JSON schema similar to the parameterSchema, but permits parameter values to refer to other parameters using the $/path/to/another/parmeter syntax. This is used to validate task parameters when workflows are created.

Returns:

  • (Hash<String, Object>) 


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

def parameters_schema_allowing_references
  @parameters_schema_allowing_references
end

#version ⇒ Integer

[Required] The version of MediaWorkflowTaskDeclaration, incremented whenever the team implementing the task processor modifies the JSON schema of this declaration's definitions, parameters or list of required parameters.

Returns:

  • (Integer) 


21
22
23
 
# File 'lib/oci/media_services/models/media_workflow_task_declaration.rb', line 21

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oci/media_services/models/media_workflow_task_declaration.rb', line 40

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'version': :'version',
    'parameters_schema': :'parametersSchema',
    'parameters_schema_allowing_references': :'parametersSchemaAllowingReferences',
    'locks': :'locks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/media_services/models/media_workflow_task_declaration.rb', line 53

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'version': :'Integer',
    'parameters_schema': :'Hash<String, Object>',
    'parameters_schema_allowing_references': :'Hash<String, Object>',
    'locks': :'Array<OCI::MediaServices::Models::ResourceLock>'
    # 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



108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/media_services/models/media_workflow_task_declaration.rb', line 108

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

  self.class == other.class &&
    name == other.name &&
    version == other.version &&
    parameters_schema == other.parameters_schema &&
    parameters_schema_allowing_references == other.parameters_schema_allowing_references &&
    locks == other.locks
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



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

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


122
123
124
 
# File 'lib/oci/media_services/models/media_workflow_task_declaration.rb', line 122

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



131
132
133
 
# File 'lib/oci/media_services/models/media_workflow_task_declaration.rb', line 131

def hash
  [name, version, parameters_schema, parameters_schema_allowing_references, locks].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



175
176
177
178
179
180
181
182
183
184
 
# File 'lib/oci/media_services/models/media_workflow_task_declaration.rb', line 175

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



169
170
171
 
# File 'lib/oci/media_services/models/media_workflow_task_declaration.rb', line 169

def to_s
  to_hash.to_s
end