Class: OCI::MediaServices::Models::JobOutput

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

Overview

The output result of an executed MediaWorkflowJob.

Constant Summary collapse

ASSET_TYPE_ENUM = 
[
  ASSET_TYPE_AUDIO = 'AUDIO'.freeze,
  ASSET_TYPE_VIDEO = 'VIDEO'.freeze,
  ASSET_TYPE_PLAYLIST = 'PLAYLIST'.freeze,
  ASSET_TYPE_IMAGE = 'IMAGE'.freeze,
  ASSET_TYPE_CAPTION_FILE = 'CAPTION_FILE'.freeze,
  ASSET_TYPE_TRANSCRIPTION_JOB = 'TRANSCRIPTION_JOB'.freeze,
  ASSET_TYPE_VISION_JOB = 'VISION_JOB'.freeze,
  ASSET_TYPE_TEXT_ANALYSIS = 'TEXT_ANALYSIS'.freeze,
  ASSET_TYPE_INPUT_FILE = 'INPUT_FILE'.freeze,
  ASSET_TYPE_OTHER = 'OTHER'.freeze,
  ASSET_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JobOutput

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :asset_type (String) —

    The value to assign to the #asset_type property

  • :namespace_name (String) —

    The value to assign to the #namespace_name property

  • :bucket_name (String) —

    The value to assign to the #bucket_name property

  • :object_name (String) —

    The value to assign to the #object_name property

  • :id (String) —

    The value to assign to the #id property

[View source]

83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/media_services/models/job_output.rb', line 83

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

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

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

  self.namespace_name = attributes[:'namespaceName'] if attributes[:'namespaceName']

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

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

  self.bucket_name = attributes[:'bucketName'] if attributes[:'bucketName']

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

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

  self.object_name = attributes[:'objectName'] if attributes[:'objectName']

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

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

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

Instance Attribute Details

#asset_type ⇒ String

Type of job output.

Returns:

  • (String) 

28
29
30
 
# File 'lib/oci/media_services/models/job_output.rb', line 28

def asset_type
  @asset_type
end

#bucket_name ⇒ String

The bucket name of the job output.

Returns:

  • (String) 

36
37
38
 
# File 'lib/oci/media_services/models/job_output.rb', line 36

def bucket_name
  @bucket_name
end

#id ⇒ String

The ID associated with the job output.

Returns:

  • (String) 

44
45
46
 
# File 'lib/oci/media_services/models/job_output.rb', line 44

def id
  @id
end

#namespace_name ⇒ String

The namespace name of the job output.

Returns:

  • (String) 

32
33
34
 
# File 'lib/oci/media_services/models/job_output.rb', line 32

def namespace_name
  @namespace_name
end

#object_name ⇒ String

The object name of the job output.

Returns:

  • (String) 

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

def object_name
  @object_name
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'asset_type': :'assetType',
    'namespace_name': :'namespaceName',
    'bucket_name': :'bucketName',
    'object_name': :'objectName',
    'id': :'id'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/media_services/models/job_output.rb', line 60

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'asset_type': :'String',
    'namespace_name': :'String',
    'bucket_name': :'String',
    'object_name': :'String',
    '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

[View source]

136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/media_services/models/job_output.rb', line 136

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

  self.class == other.class &&
    asset_type == other.asset_type &&
    namespace_name == other.namespace_name &&
    bucket_name == other.bucket_name &&
    object_name == other.object_name &&
    id == other.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

[View source]

170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/media_services/models/job_output.rb', line 170

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
[View source]

150
151
152
 
# File 'lib/oci/media_services/models/job_output.rb', line 150

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

159
160
161
 
# File 'lib/oci/media_services/models/job_output.rb', line 159

def hash
  [asset_type, namespace_name, bucket_name, object_name, id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/media_services/models/job_output.rb', line 203

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

[View source]

197
198
199
 
# File 'lib/oci/media_services/models/job_output.rb', line 197

def to_s
  to_hash.to_s
end