flytekit.clients.friendly

SynchronousFlyteClient("your.domain:port", insecure=True)
# insecure should be True if your flyteadmin deployment doesn't have SSL enabled

class SynchronousFlyteClient(
    cfg: PlatformConfig,
    kwargs,
)

def create_download_link(
    create_download_link_request: _dataproxy_pb2.CreateDownloadLinkRequest,
) -> _dataproxy_pb2.CreateDownloadLinkResponse

def create_download_location(
    create_download_location_request: _dataproxy_pb2.CreateDownloadLocationRequest,
) -> _dataproxy_pb2.CreateDownloadLocationResponse

def create_execution(
    project,
    domain,
    name,
    execution_spec,
    inputs,
) -> e: flytekit.models.core.identifier.WorkflowExecutionIdentifier

def create_launch_plan(
    launch_plan_identifer,
    launch_plan_spec,
)

def create_task(
    task_identifer,
    task_spec,
)

def create_upload_location(
    create_upload_location_request: _dataproxy_pb2.CreateUploadLocationRequest,
) -> e: flyteidl.service.dataproxy_pb2.CreateUploadLocationResponse

def create_workflow(
    workflow_identifier,
    workflow_spec,
)

def get_active_launch_plan(
    identifier,
) -> e: flytekit.models.launch_plan.LaunchPlan

def get_control_plane_version()

def get_data(
    flyte_uri: str,
) -> flyteidl.service.dataproxy_pb2.GetDataResponse

def get_domains()

def get_download_artifact_signed_url(
    node_id: str,
    project: str,
    domain: str,
    name: str,
    artifact_type: <google.protobuf.internal.enum_type_wrapper.EnumTypeWrapper object at 0x107c92350>,
    expires_in: datetime.timedelta,
) -> e: flyteidl.service.dataproxy_pb2.CreateDownloadLinkResponse

def get_download_signed_url(
    native_url: str,
    expires_in: datetime.timedelta,
) -> flyteidl.service.dataproxy_pb2.CreateDownloadLocationResponse

def get_execution(
    id,
) -> e: flytekit.models.execution.Execution

def get_execution_data(
    id,
) -> e: flytekit.models.execution.WorkflowExecutionGetDataResponse

def get_execution_metrics(
    id,
    depth,
) -> e: flyteidl.admin.execution_pb2.WorkflowExecutionGetMetricsResponse

def get_node_execution(
    node_execution_identifier,
) -> e: flytekit.models.node_execution.NodeExecution

def get_node_execution_data(
    node_execution_identifier,
) -> flytekit.models.execution.NodeExecutionGetDataResponse

def get_project_domain_attributes(
    project,
    domain,
    resource_type,
) -> n:

def get_task_execution(
    id,
) -> e: flytekit.models.admin.task_execution.TaskExecution

def get_task_execution_data(
    task_execution_identifier,
) -> e: flytekit.models.execution.NodeExecutionGetDataResponse

def get_upload_signed_url(
    project: str,
    domain: str,
    content_md5: typing.Optional[bytes],
    filename: typing.Optional[str],
    expires_in: typing.Optional[datetime.timedelta],
    filename_root: typing.Optional[str],
    add_content_md5_metadata: bool,
) -> e: flyteidl.service.dataproxy_pb2.CreateUploadLocationResponse

def get_workflow_attributes(
    project,
    domain,
    workflow,
    resource_type,
) -> n:

def list_active_launch_plans_paginated(
    project,
    domain,
    limit,
    token,
    sort_by,
) -> e: list[flytekit.models.launch_plan.LaunchPlan], str

def list_executions_paginated(
    project,
    domain,
    limit,
    token,
    filters,
    sort_by,
) -> e: (list[flytekit.models.execution.Execution], Text)

def list_launch_plan_ids_paginated(
    project,
    domain,
    limit,
    token,
    sort_by,
) -> e: list[flytekit.models.common.NamedEntityIdentifier], Text

def list_launch_plans_paginated(
    identifier,
    limit,
    token,
    filters,
    sort_by,
) -> e: list[flytekit.models.launch_plan.LaunchPlan], str

def list_matchable_attributes(
    resource_type,
) -> n:

def list_node_executions(
    workflow_execution_identifier,
    limit: int,
    token: typing.Optional[str],
    filters: typing.List[flytekit.models.filters.Filter],
    sort_by: flytekit.models.admin.common.Sort,
    unique_parent_id: str,
) -> e: list[flytekit.models.node_execution.NodeExecution], Text

def list_node_executions_for_task_paginated(
    task_execution_identifier,
    limit,
    token,
    filters,
    sort_by,
) -> e: list[flytekit.models.node_execution.NodeExecution], Text

def list_node_executions_paginated(
    node_execution_list_request,
) -> e: flyteidl.admin.node_execution_pb2.NodeExecutionList

def list_projects(
    project_list_request: typing.Optional[ProjectListRequest],
) -> e: flyteidl.admin.project_pb2.Projects

def list_projects_paginated(
    limit,
    token,
    filters,
    sort_by,
) -> e: (list[flytekit.models.Project], Text)

def list_signals(
    signal_list_request: SignalListRequest,
) -> SignalList

def list_task_executions_paginated(
    node_execution_identifier,
    limit,
    token,
    filters,
    sort_by,
) -> e: (list[flytekit.models.admin.task_execution.TaskExecution], Text)

def list_task_ids_paginated(
    project,
    domain,
    limit,
    token,
    sort_by,
) -> e: list[flytekit.models.common.NamedEntityIdentifier], Text

def list_tasks_paginated(
    identifier,
    limit,
    token,
    filters,
    sort_by,
) -> e: list[flytekit.models.task.Task], Text

def list_workflow_ids_paginated(
    project,
    domain,
    limit,
    token,
    sort_by,
) -> e: list[flytekit.models.common.NamedEntityIdentifier], Text

def list_workflows_paginated(
    identifier,
    limit,
    token,
    filters,
    sort_by,
) -> e: list[flytekit.models.admin.workflow.Workflow], Text

def recover_execution(
    id,
    name: str,
) -> e: flytekit.models.core.identifier.WorkflowExecutionIdentifier

def register_project(
    project,
) -> e: flyteidl.admin.project_pb2.ProjectRegisterResponse

def relaunch_execution(
    id,
    name,
) -> e: flytekit.models.core.identifier.WorkflowExecutionIdentifier

def set_signal(
    signal_set_request: SignalSetRequest,
) -> SignalSetResponse

def terminate_execution(
    id,
    cause,
)

def update_launch_plan(
    id,
    state,
)

def update_named_entity(
    resource_type,
    id,
    metadata,
)

def update_project(
    project,
) -> e: flyteidl.admin.project_pb2.ProjectUpdateResponse

def update_project_domain_attributes(
    project,
    domain,
    matching_attributes,
) -> n:

def update_workflow_attributes(
    project,
    domain,
    workflow,
    matching_attributes,
) -> n:

def with_root_certificate(
    cfg: PlatformConfig,
    root_cert_file: str,
) -> RawSynchronousFlyteClient