LSEG Data Library for Python

Built with Pandora

cfs.packages.Definition object

The cfs.packages.Definition object describes the file packages inside a bucket.

A package is an indivisible group of file-sets that are delivered together. Packages can consist of multiple file sets that are a grouping of file sets.

Module

lseg.data.delivery.cfs.packages

Syntax

cfs.packages.Definition(
    package_name,
    package_id,
    package_type,
    bucket_name,
    page,
    included_total_result,
    skip_token,
    page_size,
    included_entitlement_result,
)

Parameters

Value Description Data type Optional Default value
package_name Name of the package, for partial match searching. str Yes None
package_id The ID of the package. str Yes None
package_type The type of package. For example:
"core"		 str Yes None
bucket_name The name of the bucket that contains the package. str Yes None
page The offset number that determines how many pages should be returned. int Yes None
included_total_result A flag used to indicate whether the total record count should be returned. bool Yes False
skip_token A skip token is only used if a previous operation returned a partial result. 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 The number of packages that are returned in a single response. int Yes 25
included_entitlement_result A flag used to enable entitlement checking on each package. bool Yes False

Returned value

cfs.packages.Definition object

Usage

The following example demonstrates how to create the definition of the package named "VDB", with the "core" type, and found in the "TICKHISTORY_VBD_LIMITED" bucket.
Where only the 10th page that contains 10 items is retrieved.

from lseg.data.delivery import cfs


response = cfs.packages.Definition(
    package_name="VBD",
    package_type="core",
    bucket_name="TICKHISTORY_VBD_LIMITED",
    page=10,
    page_size=10,
)

None
232 words (1:13 mins)