Class: OCI::MediaServices::Models::CreateMediaWorkflowDetails

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

Overview

The information about new MediaWorkflow.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateMediaWorkflowDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



101
102
103
104
105
106
107
108
109
110
111
112
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
 
# File 'lib/oci/media_services/models/create_media_workflow_details.rb', line 101

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Compartment Identifier.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/media_services/models/create_media_workflow_details.rb', line 17

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


49
50
51
 
# File 'lib/oci/media_services/models/create_media_workflow_details.rb', line 49

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Name for the MediaWorkflow. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


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

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


43
44
45
 
# File 'lib/oci/media_services/models/create_media_workflow_details.rb', line 43

def freeform_tags
  @freeform_tags
end

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

Locks associated with this resource.

Returns:



53
54
55
 
# File 'lib/oci/media_services/models/create_media_workflow_details.rb', line 53

def locks
  @locks
end

#media_workflow_configuration_ids ⇒ Array<String>

Configurations to be applied to all the jobs for this workflow. Parameters in these configurations are overridden by parameters in the MediaWorkflowConfigurations of the MediaWorkflowJob and the parameters of the MediaWorkflowJob.

Returns:

  • (Array<String>) 


30
31
32
 
# File 'lib/oci/media_services/models/create_media_workflow_details.rb', line 30

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.

Returns:

  • (Hash<String, Object>) 


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

def parameters
  @parameters
end

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

The processing to be done in this workflow. Each key of the MediaWorkflowTasks in this array must be unique within the array. The order of tasks given here will be preserved.

Returns:



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

def tasks
  @tasks
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/media_services/models/create_media_workflow_details.rb', line 72

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



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/media_services/models/create_media_workflow_details.rb', line 151

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

  self.class == other.class &&
    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 &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/oci/media_services/models/create_media_workflow_details.rb', line 188

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


168
169
170
 
# File 'lib/oci/media_services/models/create_media_workflow_details.rb', line 168

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



177
178
179
 
# File 'lib/oci/media_services/models/create_media_workflow_details.rb', line 177

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/media_services/models/create_media_workflow_details.rb', line 221

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



215
216
217
 
# File 'lib/oci/media_services/models/create_media_workflow_details.rb', line 215

def to_s
  to_hash.to_s
end