class Twilio::REST::Serverless::V1::ServiceContext::EnvironmentContext::VariableList
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Public Class Methods
Initialize the VariableList
@param [Version] version Version
that contains the resource @param [String] service_sid The SID of the Service that the Variable resource is
associated with.
@param [String] environment_sid The SID of the Environment in which the Variable
exists.
@return [VariableList] VariableList
Twilio::REST::ListResource::new
# File lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb 26 def initialize(version, service_sid: nil, environment_sid: nil) 27 super(version) 28 29 # Path Solution 30 @solution = {service_sid: service_sid, environment_sid: environment_sid} 31 @uri = "/Services/#{@solution[:service_sid]}/Environments/#{@solution[:environment_sid]}/Variables" 32 end
Public Instance Methods
Create the VariableInstance
@param [String] key A string by which the Variable resource can be referenced.
It can be a maximum of 128 characters.
@param [String] value A string that contains the actual value of the Variable.
It can be a maximum of 450 bytes in size.
@return [VariableInstance] Created VariableInstance
# File lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb 121 def create(key: nil, value: nil) 122 data = Twilio::Values.of({'Key' => key, 'Value' => value, }) 123 124 payload = @version.create('POST', @uri, data: data) 125 126 VariableInstance.new( 127 @version, 128 payload, 129 service_sid: @solution[:service_sid], 130 environment_sid: @solution[:environment_sid], 131 ) 132 end
When passed a block, yields VariableInstance
records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
# File lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb 72 def each 73 limits = @version.read_limits 74 75 page = self.page(page_size: limits[:page_size], ) 76 77 @version.stream(page, 78 limit: limits[:limit], 79 page_limit: limits[:page_limit]).each {|x| yield x} 80 end
Retrieve a single page of VariableInstance
records from the API. Request
is executed immediately. @param [String] target_url API-generated URL for the requested results page @return [Page] Page
of VariableInstance
# File lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb 106 def get_page(target_url) 107 response = @version.domain.request( 108 'GET', 109 target_url 110 ) 111 VariablePage.new(@version, response, @solution) 112 end
Lists VariableInstance
records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
@param [Integer] page_size Number of records to fetch per request, when
not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
@return [Array] Array of up to limit results
# File lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb 45 def list(limit: nil, page_size: nil) 46 self.stream(limit: limit, page_size: page_size).entries 47 end
Retrieve a single page of VariableInstance
records from the API. Request
is executed immediately. @param [String] page_token PageToken provided by the API @param [Integer] page_number Page
Number, this value is simply for client state @param [Integer] page_size Number of records to return, defaults to 50 @return [Page] Page
of VariableInstance
# File lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb 89 def page(page_token: :unset, page_number: :unset, page_size: :unset) 90 params = Twilio::Values.of({ 91 'PageToken' => page_token, 92 'Page' => page_number, 93 'PageSize' => page_size, 94 }) 95 96 response = @version.page('GET', @uri, params: params) 97 98 VariablePage.new(@version, response, @solution) 99 end
Streams VariableInstance
records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached. @param [Integer] limit Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit.
@param [Integer] page_size Number of records to fetch per request, when
not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
@return [Enumerable] Enumerable that will yield up to limit results
# File lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb 60 def stream(limit: nil, page_size: nil) 61 limits = @version.read_limits(limit, page_size) 62 63 page = self.page(page_size: limits[:page_size], ) 64 65 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit]) 66 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb 136 def to_s 137 '#<Twilio.Serverless.V1.VariableList>' 138 end