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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

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

Initialize the DeploymentList



25
26
27
28
29
30
31
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb', line 25

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) ⇒ DeploymentInstance

Create the DeploymentInstance



117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb', line 117

def create(build_sid: :unset)
  data = Twilio::Values.of({'BuildSid' => build_sid, })

  payload = @version.create('POST', @uri, data: data)

  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.



71
72
73
74
75
76
77
78
79
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb', line 71

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.



105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb', line 105

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.



44
45
46
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb', line 44

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.



88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb', line 88

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)

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

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

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



59
60
61
62
63
64
65
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment/deployment.rb', line 59

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/serverless/v1/service/environment/deployment.rb', line 132

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