LSEG Data Library for Python

Built with Pandora

cfs.file_sets.Definition object

The cfs.file_sets.Definition object describes the indivisible set of files inside a specified bucket, including their attributes.

Module

lseg.data.delivery.cfs.file_sets

Syntax

cfs.file_sets.Definition(
    bucket,
    name,
    attributes,
    package_id,
    status,
    available_from,
    available_to,
    content_from,
    content_to,
    created_since,
    modified_since,
    skip_token,
    page_size,
)

Parameters

Value Description Data type Optional Default value
bucket The name of the bucket that contains the file set. str No None
name Name of the file set. str Yes None
attributes List of Publisher-defined key-value attributes. Each key-pair value is separated by a colon. For example:
attributes=key1:val1,key2:val2		 dict Yes None
package_id The package ID of the file set. str Yes None
status The availability status of the file set. For example:
"Ready" or "Pending"		 str Yes None
available_from The date on which the file set becomes available to retrieve. str Yes None
available_to File set availability end date. str Yes None
content_from Age of the content within the file, start date. str Yes None
content_to Age of the content within the file, end date. str Yes None
created_since The creation date of the file set. str Yes None
modified_since The last modification date of the file set. str Yes None
skip_token Used only if a previous operation returned a partial result.
For instance, if a previous response contains a nextLink element, the value of the nextLink element includes a skip token parameter that specifies a starting point to use for subsequent calls.		 str Yes None
page_size Returned file set number. int Yes 25

Returned value

cfs.file_sets.Definition object

Usage

The following example demonstrates how to create the definition of the files that are stored in the "bulk-ESG" bucket:

from lseg.data.delivery import cfs


response = cfs.file_sets.Definition(bucket="bulk-ESG")

About filesets
241 words (1:16 mins)