LSEG Data Library for Python

Built with Pandora

cfs.buckets.Definition object

The cfs.buckets.Definition object describes the parameters used to retrieve the buckets from a Client File Store (CFS), with all their attributes.

Module

lseg.data.delivery.cfs.buckets

Syntax

cfs.buckets.Definition(
    name,
    created_since,
    modified_since,
    available_from,
    available_to,
    attributes,
    page_size,
    skip_token
)

Parameters

Value Description Data type Optional Default value
name Bucket name for partial match searching. str Yes None
created_since Bucket creation date. str Yes None
modified_since Bucket modification date. str Yes None
available_from Bucket availability start date. str Yes None
available_to Bucket availability end date. str Yes None
attributes Publisher-defined bucket attributes. str, List[str] Yes None
page_size Number of buckets returned. int No 25
skip_token Skip token is used only when 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

Returned value

cfs.buckets.Definition object

Usage

The following example demonstrates how to create a bucket definition, with names containing "esg":

from lseg.data.delivery import cfs

definition = cfs.buckets.Definition(name="esg")

About buckets
149 words (0:47 mins)