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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Video::V1::CompositionSettingsInstance

Defined in:

lib/twilio-ruby/rest/video/v1/composition_settings.rb

Instance Method Summary

• #account_sid ⇒ String

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

• #aws_credentials_sid ⇒ String

  The SID of the stored Credential resource.

• #aws_s3_url ⇒ String

  The URL of the AWS S3 bucket where the compositions are stored.

• #aws_storage_enabled ⇒ Boolean

  Whether all compositions are written to the ‘aws_s3_url`.

• #context ⇒ CompositionSettingsContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #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.

• #encryption_enabled ⇒ Boolean

  Whether all compositions are stored in an encrypted form.

• #encryption_key_sid ⇒ String

  The SID of the Public Key resource used for encryption.

• #fetch ⇒ CompositionSettingsInstance

  Fetch the CompositionSettingsInstance.

• #friendly_name ⇒ String

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

• #initialize(version, payload) ⇒ CompositionSettingsInstance constructor

  Initialize the CompositionSettingsInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #url ⇒ String

  The absolute URL of the resource.

Constructor Details

#initialize(version, payload) ⇒ CompositionSettingsInstance

Initialize the CompositionSettingsInstance

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

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

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

def account_sid
    @properties['account_sid']
end

#aws_credentials_sid ⇒ String

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

def aws_credentials_sid
    @properties['aws_credentials_sid']
end

#aws_s3_url ⇒ String

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

def aws_s3_url
    @properties['aws_s3_url']
end

#aws_storage_enabled ⇒ Boolean

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

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

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

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

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

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

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

def encryption_enabled
    @properties['encryption_enabled']
end

#encryption_key_sid ⇒ String

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

def encryption_key_sid
    @properties['encryption_key_sid']
end

#fetch ⇒ CompositionSettingsInstance

Fetch the CompositionSettingsInstance

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

def fetch

    context.fetch
end

#friendly_name ⇒ String

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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#to_s ⇒ Object

Provide a user friendly representation

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

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

#url ⇒ String

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

def url
    @properties['url']
end