Transfer

Transfer

class gladier.tools.Transfer(*args, state_type: str = 'Action', state_name: str | None = None, comment: str | None = None, result_path: str | None = None, parameters: Dict[str, Any] | None = None, input_path: str | None = None, set_parameters_from_properties: bool = True, non_parameter_properties: Set[str] = {'_flow_definition', 'action_scope', 'action_url', 'comment', 'exception_handlers', 'exception_on_action_failure', 'input_path', 'next_state', 'non_parameter_properties', 'parameters', 'result_path', 'run_as', 'set_parameters_from_properties', 'state_name', 'state_type', 'wait_time'}, action_url: str = 'https://actions.globus.org/transfer/transfer', action_scope: str | None = None, wait_time: int = 600, exception_on_action_failure: bool = False, run_as: str | None = None, source_endpoint_id: str = '$.input.transfer_source_endpoint_id', destination_endpoint_id: str = '$.input.transfer_destination_endpoint_id', transfer_items: List[TransferItem] | str = [TransferItem(source_path='$.input.source_transfer_path', destination_path='$.input.destination_transfer_path', recursive=None)], notify_on_succeeded: bool | str | None = None, notify_on_failed: bool | str | None = None, notify_on_inactive: bool | str | None = None, **kwargs)

Bases: ActionState

Action Provider State for transferring files from one collection to another.

Example:

from gladier import GladierClient
from gladier.tools import GlobusTransfer

client = GladierClient(flow_definition=GlobusTransfer().get_flow_definition())
flow_run = client.run_flow(
    {"input": {
        "transfer_source_endpoint_id": "ddb59aef-6d04-11e5-ba46-22000b92c6ec",
        "transfer_destination_endpoint_id": "ddb59aef-6d04-11e5-ba46-22000b92c6ec",
        "source_transfer_path": "/share/godata",
        "destination_transfer_path": "~/"
    }}
)

Transfer Delete

class gladier.tools.TransferDelete(*args, state_type: str = 'Action', state_name: str | None = None, comment: str | None = None, result_path: str | None = None, parameters: Dict[str, Any] | None = None, input_path: str | None = None, set_parameters_from_properties: bool = True, non_parameter_properties: Set[str] = {'_flow_definition', 'action_scope', 'action_url', 'comment', 'exception_handlers', 'exception_on_action_failure', 'input_path', 'next_state', 'non_parameter_properties', 'parameters', 'result_path', 'run_as', 'set_parameters_from_properties', 'state_name', 'state_type', 'wait_time'}, action_url: str = 'https://actions.globus.org/transfer/delete', action_scope: str | None = None, wait_time: int = 600, exception_on_action_failure: bool = False, run_as: str | None = None, endpoint_id: str = '$.input.transfer_delete_endpoint_id', ignore_missing: bool | str | None = None, interpret_globs: bool | str | None = None, items: List[str] | str = '$.input.transfer_delete_items', label: str | None = None, notify_on_succeeded: bool | str | None = None, notify_on_failed: bool | str | None = None, notify_on_inactive: bool | str | None = None, recursive: bool | None = None, **kwargs)

Bases: ActionState

Action Provider state for deleting files from a Globus Collection.

Example:

from gladier import GladierClient
from gladier.tools import GlobusTransferDelete

client = GladierClient(flow_definition=GlobusTransferDelete().get_flow_definition())
flow_run = client.run_flow(
    {"input": {

        "transfer_delete_endpoint_id": "ddb59aef-6d04-11e5-ba46-22000b92c6ec",
        "transfer_delete_items": ["~/godata"],
    }}
)