UploadOptions

No overview available.

Methods

---

createWatcher()

@classmethod
def createWatcher(
    _: context.Context,
    w: containerwatcher.WatcherType
) - > (containerwatcher.Watcher, error)

Creates a watcher for a container, allowing monitoring of its state and events. Callers use this to set up observation of container activities.

Parameters

Name	Type	Description
_	context.Context	The context for the operation, typically used for cancellation or deadlines.
w	containerwatcher.WatcherType	The type of watcher to create, specifying the desired monitoring mechanism.

Returns

Type	Description
(containerwatcher.Watcher, error)	A tuple containing the created Watcher instance and an error if the creation failed.

---

uploader()

@classmethod
def uploader(
    ctx: context.Context
) - > error

Initiates the upload process for outputs based on the configured UploadOptions. Callers use this to transfer generated data to a remote storage location.

Parameters

Name	Type	Description
ctx	context.Context	The context for the upload operation, used for cancellation and timeouts.

Returns

Type	Description
error	An error if the upload process encounters any issues, otherwise nil.

---

Sidecar()

@classmethod
def Sidecar(
    ctx: context.Context
) - > error

Executes the sidecar process, which typically involves monitoring a local directory for outputs and uploading them. Callers use this to run the background process responsible for output management.

Parameters

Name	Type	Description
ctx	context.Context	The context for the sidecar operation, used for managing its lifecycle and cancellation.

Returns

Type	Description
error	An error if the sidecar process encounters any issues, otherwise nil.

---