entity_transfers

Creates, updates, deletes, gets or lists an entity_transfers resource.

Overview

Name	entity_transfers
Type	Resource
Id	linode.account.entity_transfers

Fields

The following fields are returned by SELECT queries:

get_entity_transfer

Returns an Entity Transfer object containing the details of the transfer for the specified token.

Name	Datatype	Description
created	string (date-time)	When this transfer was created. (example: 2021-02-11T16:37:03)
entities	object	A collection of the entities to include in this transfer request, separated by type.
expiry	string (date-time)	When this transfer expires. Transfers will automatically expire 24 hours after creation. (example: 2021-02-12T16:37:03)
is_sender	boolean	Filterable If the requesting account created this transfer.
status	string	Filterable The status of the transfer request: accepted: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete. canceled: The transfer has been canceled by the sender. completed: The transfer has completed successfully. failed: The transfer has failed after initiation. pending: The transfer is ready to be accepted. stale: The transfer has exceeded its expiration date. It can no longer be accepted or canceled. (example: pending)
token	string (uuid)	The token used to identify and accept or cancel this transfer. (example: 123E4567-E89B-12D3-A456-426614174000)
updated	string (date-time)	When this transfer was last updated. (example: 2021-02-11T16:37:03)

get_entity_transfers

Returns a paginated list of Entity Transfer objects containing the details of all transfers that have been created and accepted by this account.

Name	Datatype	Description
created	string (date-time)	When this transfer was created. (example: 2021-02-11T16:37:03)
entities	object	A collection of the entities to include in this transfer request, separated by type.
expiry	string (date-time)	When this transfer expires. Transfers will automatically expire 24 hours after creation. (example: 2021-02-12T16:37:03)
is_sender	boolean	Filterable If the requesting account created this transfer.
status	string	Filterable The status of the transfer request: accepted: The transfer has been accepted by another user and is currently in progress. Transfers can take up to 3 hours to complete. canceled: The transfer has been canceled by the sender. completed: The transfer has completed successfully. failed: The transfer has failed after initiation. pending: The transfer is ready to be accepted. stale: The transfer has exceeded its expiration date. It can no longer be accepted or canceled. (example: pending)
token	string (uuid)	The token used to identify and accept or cancel this transfer. (example: 123E4567-E89B-12D3-A456-426614174000)
updated	string (date-time)	When this transfer was last updated. (example: 2021-02-11T16:37:03)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_entity_transfer	select			Deprecated Please run Get a service transfer request. OAuth scopes. <br /> account:read_only<br /> Learn more...
get_entity_transfers	select		page, page_size	Deprecated Please run List service transfers. OAuth scopes. <br /> account:read_only<br /> Learn more...
post_entity_transfer	insert	data__entities		Deprecated Please run Request a service transfer. OAuth scopes. <br /> account:read_write<br /> Learn more...
delete_entity_transfer	delete			Deprecated Please run Cancel a service transfer. OAuth scopes. <br /> account:read_write<br /> Learn more...
post_accept_entity_transfer	exec			Deprecated Please run Accept a service transfer. OAuth scopes. <br /> account:read_write<br /> Learn more...

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
page	integer	The page of a collection to return.
page_size	integer	The number of items to return per page.

SELECT examples

get_entity_transfer

Deprecated Please run Get a service transfer request. OAuth scopes.

<br /> account:read_only<br />

Learn more...

SELECT
created,
entities,
expiry,
is_sender,
status,
token,
updated
FROM linode.account.entity_transfers;

get_entity_transfers

Deprecated Please run List service transfers. OAuth scopes.

<br /> account:read_only<br />

Learn more...

SELECT
created,
entities,
expiry,
is_sender,
status,
token,
updated
FROM linode.account.entity_transfers
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}';

INSERT examples

post_entity_transfer

Deprecated Please run Request a service transfer. OAuth scopes.

<br /> account:read_write<br />

Learn more...

INSERT INTO linode.account.entity_transfers (
data__entities
)
SELECT 
'{{ entities }}' --required
RETURNING
created,
entities,
expiry,
is_sender,
status,
token,
updated
;

Manifest

# Description fields are for documentation purposes
- name: entity_transfers
  props:
    - name: entities
      value: object
      description: >
        A collection of the entities to include in this transfer request, separated by type.
        

DELETE examples

delete_entity_transfer

Deprecated Please run Cancel a service transfer. OAuth scopes.

<br /> account:read_write<br />

Learn more...

DELETE FROM linode.account.entity_transfers;

Lifecycle Methods

post_accept_entity_transfer

Deprecated Please run Accept a service transfer. OAuth scopes.

<br /> account:read_write<br />

Learn more...

EXEC linode.account.entity_transfers.post_accept_entity_transfer 
;