Class: OCI::MediaServices::Models::GenerateSessionTokenDetails

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

Overview

Information about the new session token.

Constant Summary collapse

SCOPES_ENUM = 
[
  SCOPES_PLAYLIST = 'PLAYLIST'.freeze,
  SCOPES_EDGE = 'EDGE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerateSessionTokenDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :time_expires (DateTime) —

    The value to assign to the #time_expires property

  • :scopes (Array<String>) —

    The value to assign to the #scopes property

  • :packaging_config_id (String) —

    The value to assign to the #packaging_config_id property

  • :asset_ids (Array<String>) —

    The value to assign to the #asset_ids property



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/media_services/models/generate_session_token_details.rb', line 66

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

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

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

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

  self.packaging_config_id = attributes[:'packagingConfigId'] if attributes[:'packagingConfigId']

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

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

  self.asset_ids = attributes[:'assetIds'] if attributes[:'assetIds']

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

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

Instance Attribute Details

#asset_ids ⇒ Array<String>

Array of asset resource IDs used to limit the scope of the token.

Returns:

  • (Array<String>) 


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

def asset_ids
  @asset_ids
end

#packaging_config_id ⇒ String

[Required] The packaging config resource identifier used to limit the scope of the token.

Returns:

  • (String) 


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

def packaging_config_id
  @packaging_config_id
end

#scopes ⇒ Array<String>

[Required] Array of scopes the token can act upon.

Returns:

  • (Array<String>) 


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

def scopes
  @scopes
end

#time_expires ⇒ DateTime

Token expiry time. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


18
19
20
 
# File 'lib/oci/media_services/models/generate_session_token_details.rb', line 18

def time_expires
  @time_expires
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/media_services/models/generate_session_token_details.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_expires': :'timeExpires',
    'scopes': :'scopes',
    'packaging_config_id': :'packagingConfigId',
    'asset_ids': :'assetIds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/media_services/models/generate_session_token_details.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'time_expires': :'DateTime',
    'scopes': :'Array<String>',
    'packaging_config_id': :'String',
    'asset_ids': :'Array<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



115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/media_services/models/generate_session_token_details.rb', line 115

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

  self.class == other.class &&
    time_expires == other.time_expires &&
    scopes == other.scopes &&
    packaging_config_id == other.packaging_config_id &&
    asset_ids == other.asset_ids
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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/media_services/models/generate_session_token_details.rb', line 148

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


128
129
130
 
# File 'lib/oci/media_services/models/generate_session_token_details.rb', line 128

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



137
138
139
 
# File 'lib/oci/media_services/models/generate_session_token_details.rb', line 137

def hash
  [time_expires, scopes, packaging_config_id, asset_ids].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/media_services/models/generate_session_token_details.rb', line 181

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



175
176
177
 
# File 'lib/oci/media_services/models/generate_session_token_details.rb', line 175

def to_s
  to_hash.to_s
end