Class: Twilio::REST::Serverless::V1::ServiceContext::EnvironmentList

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ EnvironmentList

Initialize the EnvironmentList

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) (defaults to: nil) —

    The SID of the Service that the Environment resource is associated with.



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

def initialize(version, service_sid: nil)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid}
  @uri = "/Services/#{@solution[:service_sid]}/Environments"
end

Instance Method Details

#create(unique_name: nil, domain_suffix: :unset) ⇒ EnvironmentInstance

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

Parameters:

  • unique_name (String) (defaults to: nil) —

    An application-defined string that uniquely identifies the Environment resource. It can be used as an alternative to the sid in the URL path to address the Environment resource. This value must have fewer than 256 characters.

  • domain_suffix (String) (defaults to: :unset) —

    A URL-friendly name that represents the environment and forms part of the domain name. Must have fewer than 32 characters.

Returns:



124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 124

def create(unique_name: nil, domain_suffix: :unset)
  data = Twilio::Values.of({'UniqueName' => unique_name, 'DomainSuffix' => domain_suffix, })

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

  EnvironmentInstance.new(@version, payload, service_sid: @solution[:service_sid], )
end

#each ⇒ Object

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



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

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of EnvironmentInstance



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

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

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

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

Parameters:

  • limit (Integer) (defaults to: nil) —

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

  • page_size (Integer) (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) —

    Array of up to limit results



42
43
44
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 42

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

Parameters:

  • page_token (String) (defaults to: :unset) —

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of EnvironmentInstance



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

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
  )
  EnvironmentPage.new(@version, response, @solution)
end

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

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

Parameters:

  • limit (Integer) (defaults to: nil) —

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

  • page_size (Integer) (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) —

    Enumerable that will yield up to limit results



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

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



138
139
140
 
# File 'lib/twilio-ruby/rest/serverless/v1/service/environment.rb', line 138

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