Class: Twilio::REST::Sync::V1::ServiceContext::SyncMapContext::SyncMapItemList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.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, map_sid: nil) ⇒ SyncMapItemList

Initialize the SyncMapItemList

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The SID of the [Sync Service](www.twilio.com/docs/sync/api/service) the resource is associated with.

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

    The SID of the Sync Map that contains the Map Item.



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 26

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

  # Path Solution
  @solution = {service_sid: service_sid, map_sid: map_sid}
  @uri = "/Services/#{@solution[:service_sid]}/Maps/#{@solution[:map_sid]}/Items"
end

Instance Method Details

#create(key: nil, data: nil, ttl: :unset, item_ttl: :unset, collection_ttl: :unset) ⇒ SyncMapItemInstance

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

Parameters:

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

    The unique, user-defined key for the Map Item. Can be up to 320 characters long.

  • data (Hash) (defaults to: nil) —

    A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16KB in length.

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

    An alias for ‘item_ttl`. If both parameters are provided, this value is ignored.

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

    How long, in seconds, before the Map Item expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is ‘0`, which means the Map Item does not expire. The Map Item might not be deleted immediately after it expires.

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

    How long, in seconds, before the Map Item’s parent Sync Map expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is ‘0`, which means the parent Sync Map does not expire. The Sync Map might not be deleted immediately after it expires.

Returns:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 53

def create(key: nil, data: nil, ttl: :unset, item_ttl: :unset, collection_ttl: :unset)
  data = Twilio::Values.of({
      'Key' => key,
      'Data' => Twilio.serialize_object(data),
      'Ttl' => ttl,
      'ItemTtl' => item_ttl,
      'CollectionTtl' => collection_ttl,
  })

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

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

#each ⇒ Object

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



136
137
138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 136

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

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of SyncMapItemInstance



186
187
188
189
190
191
192
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 186

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

#list(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil) ⇒ Array

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

Parameters:

  • order (sync_map_item.QueryResultOrder) (defaults to: :unset) —

    How to order the Map Items returned by their ‘key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](en.wikipedia.org/wiki/Lexicographical_order) by Item key.

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

    The ‘key` of the first Sync Map Item resource to read. See also `bounds`.

  • bounds (sync_map_item.QueryFromBoundType) (defaults to: :unset) —

    Whether to include the Map Item referenced by the ‘from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.

  • 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



98
99
100
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 98

def list(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
  self.stream(order: order, from: from, bounds: bounds, limit: limit, page_size: page_size).entries
end

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

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

Parameters:

  • order (sync_map_item.QueryResultOrder) (defaults to: :unset) —

    How to order the Map Items returned by their ‘key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](en.wikipedia.org/wiki/Lexicographical_order) by Item key.

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

    The ‘key` of the first Sync Map Item resource to read. See also `bounds`.

  • bounds (sync_map_item.QueryFromBoundType) (defaults to: :unset) —

    Whether to include the Map Item referenced by the ‘from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.

  • 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 SyncMapItemInstance



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 164

def page(order: :unset, from: :unset, bounds: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'Order' => order,
      'From' => from,
      'Bounds' => bounds,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  SyncMapItemPage.new(@version, response, @solution)
end

#stream(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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

Parameters:

  • order (sync_map_item.QueryResultOrder) (defaults to: :unset) —

    How to order the Map Items returned by their ‘key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are [ordered lexicographically](en.wikipedia.org/wiki/Lexicographical_order) by Item key.

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

    The ‘key` of the first Sync Map Item resource to read. See also `bounds`.

  • bounds (sync_map_item.QueryFromBoundType) (defaults to: :unset) —

    Whether to include the Map Item referenced by the ‘from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.

  • 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



124
125
126
127
128
129
130
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 124

def stream(order: :unset, from: :unset, bounds: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(order: order, from: from, bounds: bounds, 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



196
197
198
 
# File 'lib/twilio-ruby/rest/sync/v1/service/sync_map/sync_map_item.rb', line 196

def to_s
  '#<Twilio.Sync.V1.SyncMapItemList>'
end