aistore.sdk.ais_source | NVIDIA AIStore

Module Contents

Classes

Name	Description
`AISSource`	Interface for all AIS class types providing access to AIS objects via URLs

API

class aistore.sdk.ais_source.AISSource()

Abstract

Interface for all AIS class types providing access to AIS objects via URLs

client

RequestClient

The client bound to the AISSource.

aistore.sdk.ais_source.AISSource.list_all_objects_iter(
    prefix: str = '',
    props: str = 'name,size'
) -> typing.Iterable[aistore.sdk.obj.object.Object]

abstract

Get an iterable of all the objects contained in this source (bucket, group, etc.)

Parameters:

prefix

strDefaults to ''

Only include objects with names matching this prefix

props

strDefaults to 'name,size'

Comma-separated list of object properties to return. Default value is “name,size”. Properties: “name”, “size”, “atime”, “version”, “checksum”, “target_url”, “copies”.

Returns: Iterable[Object]

Iterable over selected objects

aistore.sdk.ais_source.AISSource.list_urls(
    prefix: str = '',
    etl: typing.Optional[aistore.sdk.etl.ETLConfig] = None
) -> typing.Iterable[str]

abstract

Get an iterable of full urls to reference the objects contained in this source (bucket, group, etc.) Args: prefix (str, optional): Only include objects with names matching this prefix etl (Optional[ETLConfig], optional): An optional ETL configuration. If provided, the URLs will include ETL processing parameters. Defaults to None.

Returns: Iterable[str]

Iterable over selected object URLS