Class: Twilio::REST::Accounts::V1::CredentialList::AwsList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Accounts::V1::CredentialList::AwsList
- Defined in:
- lib/twilio-ruby/rest/accounts/v1/credential/aws.rb
Instance Method Summary collapse
-
#create(credentials: nil, friendly_name: :unset, account_sid: :unset) ⇒ AwsInstance
Create the AwsInstance.
-
#each ⇒ Object
When passed a block, yields AwsInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of AwsInstance records from the API.
-
#initialize(version) ⇒ AwsList
constructor
Initialize the AwsList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists AwsInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of AwsInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams AwsInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version) ⇒ AwsList
Initialize the AwsList
19 20 21 22 23 24 25 |
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 19 def initialize(version) super(version) # Path Solution @solution = {} @uri = "/Credentials/AWS" end |
Instance Method Details
#create(credentials: nil, friendly_name: :unset, account_sid: :unset) ⇒ AwsInstance
Create the AwsInstance
118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 118 def create(credentials: nil, friendly_name: :unset, account_sid: :unset) data = Twilio::Values.of({ 'Credentials' => credentials, 'FriendlyName' => friendly_name, 'AccountSid' => account_sid, }) payload = @version.create('POST', @uri, data: data) AwsInstance.new(@version, payload, ) end |
#each ⇒ Object
When passed a block, yields AwsInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
65 66 67 68 69 70 71 72 73 |
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 65 def each limits = @version.read_limits page = self.page(page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]).each {|x| yield x} end |
#get_page(target_url) ⇒ Page
Retrieve a single page of AwsInstance records from the API. Request is executed immediately.
99 100 101 102 103 104 105 |
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 99 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) AwsPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists AwsInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
38 39 40 |
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 38 def list(limit: nil, page_size: nil) self.stream(limit: limit, page_size: page_size).entries end |
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of AwsInstance records from the API. Request is executed immediately.
82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 82 def page(page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) AwsPage.new(@version, response, @solution) end |
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams AwsInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
53 54 55 56 57 58 59 |
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 53 def stream(limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page(page_size: limits[:page_size], ) @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) end |
#to_s ⇒ Object
Provide a user friendly representation
132 133 134 |
# File 'lib/twilio-ruby/rest/accounts/v1/credential/aws.rb', line 132 def to_s '#<Twilio.Accounts.V1.AwsList>' end |