Class: OCI::MediaServices::Models::CreateMediaWorkflowJobDetails

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

Overview

Information to run the MediaWorkflow. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

WORKFLOW_IDENTIFIER_TYPE_ENUM = 
[
  WORKFLOW_IDENTIFIER_TYPE_ID = 'ID'.freeze,
  WORKFLOW_IDENTIFIER_TYPE_NAME = 'NAME'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateMediaWorkflowJobDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :workflow_identifier_type (String) —

    The value to assign to the #workflow_identifier_type property

  • :media_workflow_configuration_ids (Array<String>) —

    The value to assign to the #media_workflow_configuration_ids property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :parameters (Hash<String, Object>) —

    The value to assign to the #parameters property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



113
114
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/media_services/models/create_media_workflow_job_details.rb', line 113

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

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] ID of the compartment in which the job should be created.

Returns:

  • (String) 


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

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


52
53
54
 
# File 'lib/oci/media_services/models/create_media_workflow_job_details.rb', line 52

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) 


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

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


46
47
48
 
# File 'lib/oci/media_services/models/create_media_workflow_job_details.rb', line 46

def freeform_tags
  @freeform_tags
end

#media_workflow_configuration_ids ⇒ Array<String>

Configurations to be applied to this run of the workflow.

Returns:

  • (Array<String>) 


23
24
25
 
# File 'lib/oci/media_services/models/create_media_workflow_job_details.rb', line 23

def media_workflow_configuration_ids
  @media_workflow_configuration_ids
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>) 


40
41
42
 
# File 'lib/oci/media_services/models/create_media_workflow_job_details.rb', line 40

def parameters
  @parameters
end

#workflow_identifier_type ⇒ String

[Required] Discriminate identification of a workflow by name versus a workflow by ID.

Returns:

  • (String) 


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

def workflow_identifier_type
  @workflow_identifier_type
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/media_services/models/create_media_workflow_job_details.rb', line 55

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/media_services/models/create_media_workflow_job_details.rb', line 89

def self.get_subtype(object_hash)
  type = object_hash[:'workflowIdentifierType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::MediaServices::Models::CreateMediaWorkflowJobByNameDetails' if type == 'NAME'
  return 'OCI::MediaServices::Models::CreateMediaWorkflowJobByIdDetails' if type == 'ID'

  # TODO: Log a warning when the subtype is not found.
  'OCI::MediaServices::Models::CreateMediaWorkflowJobDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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>>'
    # 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



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

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/oci/media_services/models/create_media_workflow_job_details.rb', line 209

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


189
190
191
 
# File 'lib/oci/media_services/models/create_media_workflow_job_details.rb', line 189

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



198
199
200
 
# File 'lib/oci/media_services/models/create_media_workflow_job_details.rb', line 198

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



242
243
244
245
246
247
248
249
250
251
 
# File 'lib/oci/media_services/models/create_media_workflow_job_details.rb', line 242

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



236
237
238
 
# File 'lib/oci/media_services/models/create_media_workflow_job_details.rb', line 236

def to_s
  to_hash.to_s
end