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

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

Instance Method Summary collapse

Constructor Details

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

Initialize the DeploymentList



29
30
31
32
33
34
35
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.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]}/Deployments"
    
end

Instance Method Details

#create(build_sid: :unset, is_plugin: :unset) ⇒ DeploymentInstance

Create the DeploymentInstance



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

def create(
    build_sid: :unset, 
    is_plugin: :unset
)

    data = Twilio::Values.of({
        'BuildSid' => build_sid,
        'IsPlugin' => is_plugin,
    })

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

#each ⇒ Object

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



109
110
111
112
113
114
115
116
117
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb', line 109

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



146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb', line 146

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

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

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



78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb', line 78

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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb', line 126

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)

    DeploymentPage.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.



96
97
98
99
100
101
102
103
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb', line 96

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



157
158
159
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb', line 157

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