DatasetClient <Data>
Hierarchy
- ResourceClient
- DatasetClient
Index
Properties
inheritedapifyClient
inheritedbaseUrl
inheritedhttpClient
optionalinheritedid
optionalinheritedparams
inheritedresourcePath
optionalinheritedsafeId
inheritedurl
Methods
createItemsPublicUrl
Parameters
options: DatasetClientListItemOptions = {}
optionalexpiresInMillis: number
Returns Promise<string>
delete
Returns Promise<void>
downloadItems
Unlike
listItemswhich returns a PaginationList with an array of individual dataset items,downloadItemsreturns the items serialized to the provided format. https://docs.apify.com/api/v2#/reference/datasets/item-collection/get-itemsParameters
format: DownloadItemsFormat
options: DatasetClientDownloadItemsOptions = {}
Returns Promise<Buffer>
get
Returns Promise<undefined | Dataset>
getStatistics
Returns Promise<undefined | DatasetStatistics>
listItems
Parameters
options: DatasetClientListItemOptions = {}
Returns Promise<PaginatedList<Data>>
pushItems
Parameters
items: string | string[] | Data | Data[]
Returns Promise<void>
update
Parameters
newFields: DatasetClientUpdateOptions
Returns Promise<Dataset>
Generates a URL that can be used to access dataset items.
If the client has permission to access the dataset's URL signing key, the URL will include a signature to verify its authenticity.
You can optionally control how long the signed URL should be valid using the
expiresInMillisoption. This value sets the expiration duration in milliseconds from the time the URL is generated. If not provided, the URL will not expire.Any other options (like
limitorprefix) will be included as query parameters in the URL.