twilio.rest.serverless.v1.service.function package

Module contents

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.serverless.v1.service.function.FunctionContext(version, service_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

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

delete()[source]

Deletes the FunctionInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the FunctionInstance

Returns:The fetched FunctionInstance
Return type:twilio.rest.serverless.v1.service.function.FunctionInstance
function_versions

Access the function_versions

Returns:twilio.rest.serverless.v1.service.function.function_version.FunctionVersionList
Return type:twilio.rest.serverless.v1.service.function.function_version.FunctionVersionList
update(friendly_name)[source]

Update the FunctionInstance

Parameters:friendly_name (unicode) – A string to describe the Function resource
Returns:The updated FunctionInstance
Return type:twilio.rest.serverless.v1.service.function.FunctionInstance
class twilio.rest.serverless.v1.service.function.FunctionInstance(version, payload, service_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

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

account_sid
Returns:The SID of the Account that created the Function resource
Return type:unicode
date_created
Returns:The ISO 8601 date and time in GMT when the Function resource was created
Return type:datetime
date_updated
Returns:The ISO 8601 date and time in GMT when the Function resource was last updated
Return type:datetime
delete()[source]

Deletes the FunctionInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the FunctionInstance

Returns:The fetched FunctionInstance
Return type:twilio.rest.serverless.v1.service.function.FunctionInstance
friendly_name
Returns:The string that you assigned to describe the Function resource
Return type:unicode
function_versions

Access the function_versions

Returns:twilio.rest.serverless.v1.service.function.function_version.FunctionVersionList
Return type:twilio.rest.serverless.v1.service.function.function_version.FunctionVersionList
Returns:The URLs of nested resources of the Function resource
Return type:unicode
service_sid
Returns:The SID of the Service that the Function resource is associated with
Return type:unicode
sid
Returns:The unique string that identifies the Function resource
Return type:unicode
update(friendly_name)[source]

Update the FunctionInstance

Parameters:friendly_name (unicode) – A string to describe the Function resource
Returns:The updated FunctionInstance
Return type:twilio.rest.serverless.v1.service.function.FunctionInstance
url
Returns:The absolute URL of the Function resource
Return type:unicode
class twilio.rest.serverless.v1.service.function.FunctionList(version, service_sid)[source]

Bases: twilio.base.list_resource.ListResource

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

create(friendly_name)[source]

Create the FunctionInstance

Parameters:friendly_name (unicode) – A string to describe the Function resource
Returns:The created FunctionInstance
Return type:twilio.rest.serverless.v1.service.function.FunctionInstance
get(sid)[source]

Constructs a FunctionContext

Parameters:sid – The SID of the Function resource to fetch
Returns:twilio.rest.serverless.v1.service.function.FunctionContext
Return type:twilio.rest.serverless.v1.service.function.FunctionContext
get_page(target_url)[source]

Retrieve a specific page of FunctionInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of FunctionInstance
Return type:twilio.rest.serverless.v1.service.function.FunctionPage
list(limit=None, page_size=None)[source]

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

Parameters:
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – 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, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.serverless.v1.service.function.FunctionInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of FunctionInstance

Return type:

twilio.rest.serverless.v1.service.function.FunctionPage

stream(limit=None, page_size=None)[source]

Streams FunctionInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – 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:

Generator that will yield up to limit results

Return type:

list[twilio.rest.serverless.v1.service.function.FunctionInstance]

class twilio.rest.serverless.v1.service.function.FunctionPage(version, response, solution)[source]

Bases: twilio.base.page.Page

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

get_instance(payload)[source]

Build an instance of FunctionInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.serverless.v1.service.function.FunctionInstance
Return type:twilio.rest.serverless.v1.service.function.FunctionInstance