Class: Twilio::REST::Video::V1::CompositionSettingsInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/video/v1/composition_settings.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ CompositionSettingsInstance

Initialize the CompositionSettingsInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this CompositionSettings resource.

  • sid (String) —

    The SID of the Call resource to fetch.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/twilio-ruby/rest/video/v1/composition_settings.rb', line 169

def initialize(version, payload )
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'friendly_name' => payload['friendly_name'],
        'aws_credentials_sid' => payload['aws_credentials_sid'],
        'aws_s3_url' => payload['aws_s3_url'],
        'aws_storage_enabled' => payload['aws_storage_enabled'],
        'encryption_key_sid' => payload['encryption_key_sid'],
        'encryption_enabled' => payload['encryption_enabled'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = {  }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the CompositionSettings resource.

Returns:



202
203
204
 
# File 'lib/twilio-ruby/rest/video/v1/composition_settings.rb', line 202

def 
    @properties['account_sid']
end

#aws_credentials_sid ⇒ String

Returns The SID of the stored Credential resource.

Returns:

  • (String) —

    The SID of the stored Credential resource.



214
215
216
 
# File 'lib/twilio-ruby/rest/video/v1/composition_settings.rb', line 214

def aws_credentials_sid
    @properties['aws_credentials_sid']
end

#aws_s3_url ⇒ String

Returns The URL of the AWS S3 bucket where the compositions are stored. We only support DNS-compliant URLs like ‘documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](tools.ietf.org/html/rfc3986#section-2).

Returns:



220
221
222
 
# File 'lib/twilio-ruby/rest/video/v1/composition_settings.rb', line 220

def aws_s3_url
    @properties['aws_s3_url']
end

#aws_storage_enabled ⇒ Boolean

Returns Whether all compositions are written to the ‘aws_s3_url`. When `false`, all compositions are stored in our cloud.

Returns:

  • (Boolean) —

    Whether all compositions are written to the ‘aws_s3_url`. When `false`, all compositions are stored in our cloud.



226
227
228
 
# File 'lib/twilio-ruby/rest/video/v1/composition_settings.rb', line 226

def aws_storage_enabled
    @properties['aws_storage_enabled']
end

#context ⇒ CompositionSettingsContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



193
194
195
196
197
198
 
# File 'lib/twilio-ruby/rest/video/v1/composition_settings.rb', line 193

def context
    unless @instance_context
        @instance_context = CompositionSettingsContext.new(@version )
    end
    @instance_context
end

#create(friendly_name: nil, aws_credentials_sid: :unset, encryption_key_sid: :unset, aws_s3_url: :unset, aws_storage_enabled: :unset, encryption_enabled: :unset) ⇒ CompositionSettingsInstance

Create the CompositionSettingsInstance

Parameters:

  • friendly_name (String) (defaults to: nil) —

    A descriptive string that you create to describe the resource and show to the user in the console

  • aws_credentials_sid (String) (defaults to: :unset) —

    The SID of the stored Credential resource.

  • encryption_key_sid (String) (defaults to: :unset) —

    The SID of the Public Key resource to use for encryption.

  • aws_s3_url (String) (defaults to: :unset) —

    The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like ‘documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](tools.ietf.org/html/rfc3986#section-2).

  • aws_storage_enabled (Boolean) (defaults to: :unset) —

    Whether all compositions should be written to the ‘aws_s3_url`. When `false`, all compositions are stored in our cloud.

  • encryption_enabled (Boolean) (defaults to: :unset) —

    Whether all compositions should be stored in an encrypted form. The default is ‘false`.

Returns:



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/twilio-ruby/rest/video/v1/composition_settings.rb', line 257

def create(
    friendly_name: nil, 
    aws_credentials_sid: :unset, 
    encryption_key_sid: :unset, 
    aws_s3_url: :unset, 
    aws_storage_enabled: :unset, 
    encryption_enabled: :unset
)

    context.create(
        friendly_name: friendly_name, 
        aws_credentials_sid: aws_credentials_sid, 
        encryption_key_sid: encryption_key_sid, 
        aws_s3_url: aws_s3_url, 
        aws_storage_enabled: aws_storage_enabled, 
        encryption_enabled: encryption_enabled, 
    )
end

#encryption_enabled ⇒ Boolean

Returns Whether all compositions are stored in an encrypted form. The default is ‘false`.

Returns:

  • (Boolean) —

    Whether all compositions are stored in an encrypted form. The default is ‘false`.



238
239
240
 
# File 'lib/twilio-ruby/rest/video/v1/composition_settings.rb', line 238

def encryption_enabled
    @properties['encryption_enabled']
end

#encryption_key_sid ⇒ String

Returns The SID of the Public Key resource used for encryption.

Returns:

  • (String) —

    The SID of the Public Key resource used for encryption.



232
233
234
 
# File 'lib/twilio-ruby/rest/video/v1/composition_settings.rb', line 232

def encryption_key_sid
    @properties['encryption_key_sid']
end

#fetch ⇒ CompositionSettingsInstance

Fetch the CompositionSettingsInstance

Returns:



279
280
281
282
 
# File 'lib/twilio-ruby/rest/video/v1/composition_settings.rb', line 279

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource and that will be shown in the console.

Returns:

  • (String) —

    The string that you assigned to describe the resource and that will be shown in the console



208
209
210
 
# File 'lib/twilio-ruby/rest/video/v1/composition_settings.rb', line 208

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



293
294
295
296
 
# File 'lib/twilio-ruby/rest/video/v1/composition_settings.rb', line 293

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Video.V1.CompositionSettingsInstance #{values}>"
end

#to_s ⇒ Object

Provide a user friendly representation



286
287
288
289
 
# File 'lib/twilio-ruby/rest/video/v1/composition_settings.rb', line 286

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Video.V1.CompositionSettingsInstance #{values}>"
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



244
245
246
 
# File 'lib/twilio-ruby/rest/video/v1/composition_settings.rb', line 244

def url
    @properties['url']
end