Class: OCI::MediaServices::Models::CreateMediaWorkflowJobByIdDetails

Inherits:
CreateMediaWorkflowJobDetails show all
Defined in:
lib/oci/media_services/models/create_media_workflow_job_by_id_details.rb

Overview

Information to run a MediaWorkflow identified by its OCID.

Constant Summary

Constants inherited from CreateMediaWorkflowJobDetails

OCI::MediaServices::Models::CreateMediaWorkflowJobDetails::WORKFLOW_IDENTIFIER_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateMediaWorkflowJobDetails

#compartment_id, #defined_tags, #display_name, #freeform_tags, #locks, #media_workflow_configuration_ids, #parameters, #workflow_identifier_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateMediaWorkflowJobDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateMediaWorkflowJobByIdDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/media_services/models/create_media_workflow_job_by_id_details.rb', line 64

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['workflowIdentifierType'] = 'ID'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

Instance Attribute Details

#media_workflow_id ⇒ String

OCID of the MediaWorkflow that should be run.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/media_services/models/create_media_workflow_job_by_id_details.rb', line 14

def media_workflow_id
  @media_workflow_id
end

Class Method Details

.attribute_map ⇒ Object

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



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/oci/media_services/models/create_media_workflow_job_by_id_details.rb', line 17

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'workflow_identifier_type': :'workflowIdentifierType',
    'media_workflow_configuration_ids': :'mediaWorkflowConfigurationIds',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'parameters': :'parameters',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'locks': :'locks',
    'media_workflow_id': :'mediaWorkflowId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/media_services/models/create_media_workflow_job_by_id_details.rb', line 34

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'workflow_identifier_type': :'String',
    'media_workflow_configuration_ids': :'Array<String>',
    'compartment_id': :'String',
    'display_name': :'String',
    'parameters': :'Hash<String, Object>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'locks': :'Array<OCI::MediaServices::Models::ResourceLock>',
    'media_workflow_id': :'String'
    # 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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/media_services/models/create_media_workflow_job_by_id_details.rb', line 88

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

  self.class == other.class &&
    workflow_identifier_type == other.workflow_identifier_type &&
    media_workflow_configuration_ids == other.media_workflow_configuration_ids &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    parameters == other.parameters &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    locks == other.locks &&
    media_workflow_id == other.media_workflow_id
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



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

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



115
116
117
 
# File 'lib/oci/media_services/models/create_media_workflow_job_by_id_details.rb', line 115

def hash
  [workflow_identifier_type, media_workflow_configuration_ids, compartment_id, display_name, parameters, freeform_tags, defined_tags, locks, media_workflow_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/media_services/models/create_media_workflow_job_by_id_details.rb', line 159

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



153
154
155
 
# File 'lib/oci/media_services/models/create_media_workflow_job_by_id_details.rb', line 153

def to_s
  to_hash.to_s
end