Class: OCI::MediaServices::Models::MediaAssetDistributionChannelAttachmentSummary

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

Overview

Summary of the MediaAssetDistributionChannelAttachment.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MediaAssetDistributionChannelAttachmentSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :media_asset_id (String) —

    The value to assign to the #media_asset_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :distribution_channel_id (String) —

    The value to assign to the #distribution_channel_id property

  • :version (Integer) —

    The value to assign to the #version property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :metadata_ref (String) —

    The value to assign to the #metadata_ref property

  • :media_workflow_job_id (String) —

    The value to assign to the #media_workflow_job_id property



91
92
93
94
95
96
97
98
99
100
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
 
# File 'lib/oci/media_services/models/media_asset_distribution_channel_attachment_summary.rb', line 91

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

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

  self.media_asset_id = attributes[:'media_asset_id'] if attributes[:'media_asset_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.distribution_channel_id = attributes[:'distributionChannelId'] if attributes[:'distributionChannelId']

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

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.metadata_ref = attributes[:'metadataRef'] if attributes[:'metadataRef']

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

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

  self.media_workflow_job_id = attributes[:'mediaWorkflowJobId'] if attributes[:'mediaWorkflowJobId']

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

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

Instance Attribute Details

#display_name ⇒ String

Display name for the MediaAssetDistributionChannelAttachment. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/media_services/models/media_asset_distribution_channel_attachment_summary.rb', line 26

def display_name
  @display_name
end

#distribution_channel_id ⇒ String

[Required] OCID of associated Distribution Channel.

Returns:

  • (String) 


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

def distribution_channel_id
  @distribution_channel_id
end

#lifecycle_state ⇒ String

[Required] Lifecycle state of the attachment.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/media_services/models/media_asset_distribution_channel_attachment_summary.rb', line 38

def lifecycle_state
  @lifecycle_state
end

#media_asset_id ⇒ String

[Required] OCID of associated media asset.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/media_services/models/media_asset_distribution_channel_attachment_summary.rb', line 22

def media_asset_id
  @media_asset_id
end

#media_workflow_job_id ⇒ String

The ingest MediaWorkflowJob ID that created this attachment.

Returns:

  • (String) 


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

def media_workflow_job_id
  @media_workflow_job_id
end

#metadata_ref ⇒ String

[Required] The identifier for the metadata.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/media_services/models/media_asset_distribution_channel_attachment_summary.rb', line 42

def metadata_ref
  @metadata_ref
end

#version ⇒ Integer

[Required] Version number of the attachment.

Returns:

  • (Integer) 


34
35
36
 
# File 'lib/oci/media_services/models/media_asset_distribution_channel_attachment_summary.rb', line 34

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/media_services/models/media_asset_distribution_channel_attachment_summary.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'media_asset_id': :'mediaAssetId',
    'display_name': :'displayName',
    'distribution_channel_id': :'distributionChannelId',
    'version': :'version',
    'lifecycle_state': :'lifecycleState',
    'metadata_ref': :'metadataRef',
    'media_workflow_job_id': :'mediaWorkflowJobId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'media_asset_id': :'String',
    'display_name': :'String',
    'distribution_channel_id': :'String',
    'version': :'Integer',
    'lifecycle_state': :'String',
    'metadata_ref': :'String',
    'media_workflow_job_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



156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/media_services/models/media_asset_distribution_channel_attachment_summary.rb', line 156

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

  self.class == other.class &&
    media_asset_id == other.media_asset_id &&
    display_name == other.display_name &&
    distribution_channel_id == other.distribution_channel_id &&
    version == other.version &&
    lifecycle_state == other.lifecycle_state &&
    metadata_ref == other.metadata_ref &&
    media_workflow_job_id == other.media_workflow_job_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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/media_services/models/media_asset_distribution_channel_attachment_summary.rb', line 192

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


172
173
174
 
# File 'lib/oci/media_services/models/media_asset_distribution_channel_attachment_summary.rb', line 172

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



181
182
183
 
# File 'lib/oci/media_services/models/media_asset_distribution_channel_attachment_summary.rb', line 181

def hash
  [media_asset_id, display_name, distribution_channel_id, version, lifecycle_state, metadata_ref, media_workflow_job_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



225
226
227
228
229
230
231
232
233
234
 
# File 'lib/oci/media_services/models/media_asset_distribution_channel_attachment_summary.rb', line 225

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



219
220
221
 
# File 'lib/oci/media_services/models/media_asset_distribution_channel_attachment_summary.rb', line 219

def to_s
  to_hash.to_s
end