Class: Twilio::REST::Serverless::V1::ServiceContext::EnvironmentContext::VariableList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil, environment_sid: nil) ⇒ VariableList

Initialize the VariableList

Parameters:

  • Version that contains the resource



29
30
31
32
33
34
35
36
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 29

def initialize(version, service_sid: nil, environment_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { service_sid: service_sid, environment_sid: environment_sid }
    @uri = "/Services/#{@solution[:service_sid]}/Environments/#{@solution[:environment_sid]}/Variables"
    
end

Instance Method Details

#create(key: nil, value: nil) ⇒ VariableInstance

Create the VariableInstance

Parameters:

  • (defaults to: nil)

    A string by which the Variable resource can be referenced. It can be a maximum of 128 characters.

  • (defaults to: nil)

    A string that contains the actual value of the Variable. It can be a maximum of 450 bytes in size.

Returns:

  • Created VariableInstance



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 42

def create(
    key: nil, 
    value: nil
)

    data = Twilio::Values.of({
        'Key' => key,
        'Value' => value,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    VariableInstance.new(
        @version,
        payload,
        service_sid: @solution[:service_sid],
        environment_sid: @solution[:environment_sid],
    )
end

#create_with_metadata(key: nil, value: nil) ⇒ VariableInstance

Create the VariableInstanceMetadata

Parameters:

  • (defaults to: nil)

    A string by which the Variable resource can be referenced. It can be a maximum of 128 characters.

  • (defaults to: nil)

    A string that contains the actual value of the Variable. It can be a maximum of 450 bytes in size.

Returns:

  • Created VariableInstance



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 72

def create_with_metadata(
  key: nil, 
  value: nil
)

    data = Twilio::Values.of({
        'Key' => key,
        'Value' => value,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    variable_instance = VariableInstance.new(
        @version,
        response.body,
        service_sid: @solution[:service_sid],
        environment_sid: @solution[:environment_sid],
    )
    VariableInstanceMetadata.new(
        @version,
        variable_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

When passed a block, yields VariableInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



168
169
170
171
172
173
174
175
176
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 168

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 VariableInstance records from the API. Request is executed immediately.

Parameters:

  • API-generated URL for the requested results page

Returns:

  • Page of VariableInstance



205
206
207
208
209
210
211
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 205

def get_page(target_url)
    response = @version.domain.request(
        'GET',
        target_url
    )
VariablePage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists VariableInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (defaults to: nil)

    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)

Returns:

  • Array of up to limit results



115
116
117
118
119
120
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 115

def list(limit: nil, page_size: nil)
    self.stream(
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(limit: nil, page_size: nil) ⇒ Array

Lists VariablePageMetadata records from the API as a list.

Parameters:

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (defaults to: nil)

    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)

Returns:

  • Array of up to limit results



151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 151

def list_with_metadata(limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    VariablePageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of VariableInstance records from the API. Request is executed immediately.

Parameters:

  • (defaults to: :unset)

    PageToken provided by the API

  • (defaults to: :unset)

    Page Number, this value is simply for client state

  • (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • Page of VariableInstance



185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 185

def page(page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    VariablePage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (defaults to: nil)

    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)

Returns:

  • Enumerable that will yield up to limit results



133
134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 133

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



216
217
218
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb', line 216

def to_s
    '#<Twilio.Serverless.V1.VariableList>'
end