Flyte 2 is available today for local execution - distributed execution coming to open source soon. Preview Flyte 2 for production, hosted on Union.ai

flyte.remote

Remote Entities that are accessible from the Union Server once deployed or created.

Directory

Classes

Class	Description
`Action`	A class representing an action.
`ActionDetails`	A class representing an action.
`ActionInputs`	A class representing the inputs of an action.
`ActionOutputs`	A class representing the outputs of an action.
`App`
`Project`	A class representing a project in the Union API.
`Run`	A class representing a run of a task.
`RunDetails`	A class representing a run of a task.
`Secret`
`Task`
`TaskDetails`
`TimeFilter`	Filter for time-based fields (e.
`Trigger`	Represents a trigger in the Flyte platform.
`User`	Represents a user in the Flyte platform.

Methods

Method	Description
`auth_metadata()`	This context manager allows you to pass contextualized auth metadata downstream to the Flyte authentication system.
`upload_dir()`	Uploads a directory to a remote location and returns the remote URI.
`upload_file()`	Uploads a file to a remote location and returns the remote URI.

Methods

auth_metadata()

        
    
def auth_metadata(
    kv: typing.Tuple[str, str],
)

This context manager allows you to pass contextualized auth metadata downstream to the Flyte authentication system.

This is only useful if flyte.init_passthrough() has been called.

        
flyte.init_passthrough("my-endpoint")

...

with auth_metadata((key1, value1), (key2, value2)):
    ...

Parameter	Type	Description
`kv`	`typing.Tuple[str, str]`

upload_dir()

This method can be called both synchronously or asynchronously.

Default invocation is sync and will block. To call it asynchronously, use the function .aio() on the method name itself, e.g.,: result = await upload_dir.aio().

        
    
def upload_dir(
    dir_path: pathlib.Path,
    verify: bool,
    prefix: str | None,
) -> str

Uploads a directory to a remote location and returns the remote URI.

Parameter	Type	Description
`dir_path`	`pathlib.Path`	The directory path to upload.
`verify`	`bool`	Whether to verify the certificate for HTTPS requests.
`prefix`	`str \| None`

Returns: The remote URI of the uploaded directory.

upload_file()

This method can be called both synchronously or asynchronously.

Default invocation is sync and will block. To call it asynchronously, use the function .aio() on the method name itself, e.g.,: result = await upload_file.aio().

        
    
def upload_file(
    fp: pathlib.Path,
    verify: bool,
    fname: str | None,
) -> typing.Tuple[str, str]

Uploads a file to a remote location and returns the remote URI.

Parameter	Type	Description
`fp`	`pathlib.Path`	The file path to upload.
`verify`	`bool`	Whether to verify the certificate for HTTPS requests.
`fname`	`str \| None`	Optional file name for the remote path.

Returns: Tuple of (MD5 digest hex string, remote native URL).