Class: Twilio::REST::Serverless::V1::ServiceContext::BuildList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ BuildList

Initialize the BuildList



28
29
30
31
32
33
34
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/build.rb', line 28

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

Instance Method Details

#create(asset_versions: :unset, function_versions: :unset, dependencies: :unset, runtime: :unset) ⇒ BuildInstance

Create the BuildInstance



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

def create(
    asset_versions: :unset, 
    function_versions: :unset, 
    dependencies: :unset, 
    runtime: :unset
)

    data = Twilio::Values.of({
        'AssetVersions' => Twilio.serialize_list(asset_versions) { |e| e },
        'FunctionVersions' => Twilio.serialize_list(function_versions) { |e| e },
        'Dependencies' => dependencies,
        'Runtime' => runtime,
    })

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

#each ⇒ Object

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



113
114
115
116
117
118
119
120
121
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/build.rb', line 113

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



150
151
152
153
154
155
156
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/build.rb', line 150

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

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

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



82
83
84
85
86
87
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/build.rb', line 82

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/build.rb', line 130

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)

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



100
101
102
103
104
105
106
107
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/build.rb', line 100

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



161
162
163
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/build.rb', line 161

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