Class: OCI::MediaServices::Models::StreamDistributionChannel

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

Overview

Channel used for delivering video streams to the end-users.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ StreamDistributionChannel

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :domain_name (String) —

    The value to assign to the #domain_name property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state 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

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

    The value to assign to the #system_tags property

  • :locks (Array<OCI::MediaServices::Models::ResourceLock>) —

    The value to assign to the #locks property



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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 124

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

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Compartment Identifier.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 29

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


57
58
59
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 57

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Stream Distribution Channel display name. Avoid entering confidential information.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 25

def display_name
  @display_name
end

#domain_name ⇒ String

Unique domain name of the Distribution Channel.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 33

def domain_name
  @domain_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>) 


51
52
53
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 51

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 21

def id
  @id
end

#lifecycle_state ⇒ String

The current state of the Stream Distribution Channel.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 45

def lifecycle_state
  @lifecycle_state
end

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

Locks associated with this resource.

Returns:



67
68
69
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 67

def locks
  @locks
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


63
64
65
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 63

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

The time when the Stream Distribution Channel was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time when the Stream Distribution Channel was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


41
42
43
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 41

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'domain_name': :'domainName',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'locks': :'locks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 89

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'domain_name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 209

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    domain_name == other.domain_name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 249

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


229
230
231
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 229

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



238
239
240
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 238

def hash
  [id, display_name, compartment_id, domain_name, time_created, time_updated, lifecycle_state, freeform_tags, defined_tags, system_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



282
283
284
285
286
287
288
289
290
291
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 282

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



276
277
278
 
# File 'lib/oci/media_services/models/stream_distribution_channel.rb', line 276

def to_s
  to_hash.to_s
end