aistore.sdk.batch.types | NVIDIA AIStore

Module Contents

Classes

Name	Description
`MossIn`	Matches apc.MossIn in Go.
`MossOut`	MOSS (Multi-Object Streaming Service) response. Matches apc.MossOut in Go - Response for each object
`MossReq`	MOSS (Multi-Object Streaming Service) request. Matches apc.MossReq in Go.
`MossResp`	Matches apc.MossResp in Go

API

class aistore.sdk.batch.types.MossIn()

Bases: BaseModel

Matches apc.MossIn in Go.

archpath

Optional[str] = Field(default=None, alias=GB_ARCHPATH)

bck

Optional[str] = Field(default=None, alias=GB_BCK)

length

Optional[int] = Field(default=None, alias=GB_LENGTH)

model_config

= {'populate_by_name': True}

obj_name

str = Field(alias=GB_OBJNAME)

opaque

Optional[str] = Field(default=None, alias=GB_OPAQUE)

provider

Optional[str] = Field(default=None, alias=GB_PROVIDER)

start

Optional[int] = Field(default=None, alias=GB_START)

uname

Optional[str] = Field(default=None, alias=GB_UNAME)

aistore.sdk.batch.types.MossIn.dict(
    _args = (),
    _kwargs = {}
) -> typing.Dict

class aistore.sdk.batch.types.MossOut()

Bases: BaseModel

MOSS (Multi-Object Streaming Service) response. Matches apc.MossOut in Go - Response for each object

archpath

Optional[str] = Field(default=None, alias=GB_ARCHPATH)

bucket

str = Field(alias=GB_BCK)

err_msg

Optional[str] = Field(default=None, alias=GB_ERR_MSG)

model_config

= {'populate_by_name': True}

obj_name

str = Field(alias=GB_OBJNAME)

opaque

Optional[bytes] = Field(default=None, alias=GB_OPAQUE)

provider

str = Field(alias=GB_PROVIDER)

size

int = Field(default=0, alias=GB_SIZE)

aistore.sdk.batch.types.MossOut.decode_opaque(
    opaque_val
)

Automatically decode base64 encoded opaque field back to bytes.

Parameters:

opaque_val

Union[str, bytes, None]

The raw opaque value. Can be a base64-encoded string, already decoded bytes, or None if no opaque data was provided.

Returns:

Optional[bytes]: Decoded bytes or None

aistore.sdk.batch.types.MossOut.dict(
    _args = (),
    _kwargs = {}
) -> typing.Dict

class aistore.sdk.batch.types.MossReq()

Bases: BaseModel

MOSS (Multi-Object Streaming Service) request. Matches apc.MossReq in Go.

colocation

Optional[int] = Field(default=None, alias=GB_COLOC)

cont_on_err

Optional[bool] = Field(default=None, alias=GB_CONTINUE_ERR)

model_config

= {'populate_by_name': True}

moss_in

List[MossIn] = Field(default_factory=list, alias=GB_IN)

only_obj_name

Optional[bool] = Field(default=None, alias=GB_ONLY_OBJ_NAME)

output_format

Optional[str] = Field(default=None, alias=GB_OUTPUT_FMT)

streaming_get

Optional[bool] = Field(default=None, alias=GB_STRM_GET)

aistore.sdk.batch.types.MossReq.add(
    moss_in: aistore.sdk.batch.types.MossIn
) -> aistore.sdk.batch.types.MossReq

Add a MossIn request. Returns self for chaining.

Parameters:

moss_in

MossIn

MossIn object to add to the request

Returns: MossReq

Self for method chaining

aistore.sdk.batch.types.MossReq.dict(
    _args = (),
    _kwargs = {}
) -> typing.Dict

aistore.sdk.batch.types.MossReq.extend(
    moss_ins: typing.List[aistore.sdk.batch.types.MossIn]
) -> aistore.sdk.batch.types.MossReq

Add multiple MossIn requests. Returns self for chaining.

Parameters:

moss_ins

List[MossIn]

List of MossIn objects to add

Returns: MossReq

Self for method chaining

class aistore.sdk.batch.types.MossResp()

Bases: BaseModel

Matches apc.MossResp in Go

model_config

= {'populate_by_name': True}

out

List[MossOut] = Field(default_factory=list, alias=GB_OUT)

uuid

str = Field(default='', alias=GB_UUID)