LSEG Data Library for Python

Built with Pandora

cfs.files.Definition object

The cfs.files.Definition object describes the files inside a specified file-set, together with their attributes.

Module

lseg.data.delivery.cfs.files

Syntax

cfs.files.Definition(
    fileset_id,
    file_name,
    created_since,
    modified_since,
    skip_token,
    page_size
)

Parameters

Value Description Data type Optional Default value
fileset_id The ID of the file set, used for searching. str No -
file_name The name of the file, used for partial match searching. str Yes None
created_since Creation date of the file. str, datetime, timedelta Yes None
modified_since The last modification date of the file. str, datetime, timedelta Yes None
skip_token A skip token is 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 Number of buckets returned. int Yes 25

Returned value

cfs.files.Definition object

Usage

The following example demonstrates how to create the definition of the file, where its ID is '400a-a458-106d24dc-b0ea-fb8baf45d631':

from lseg.data.delivery import cfs

definition = cfs.files.Definition(fileset_id='400a-a458-106d24dc-b0ea-fb8baf45d631')

None
150 words (0:47 mins)