flytekit.clients.raw

Directory

Classes

flytekit.clients.raw.DataProxyServiceStub

DataProxyService defines an RPC Service that allows access to user-data in a controlled manner.

def DataProxyServiceStub(
    channel,
):

Constructor.

flytekit.clients.raw.GetDomainRequest

A ProtocolMessage

flytekit.clients.raw.PlatformConfig

This object contains the settings to talk to a Flyte backend (the DNS location of your Admin server basically).

def PlatformConfig(
    endpoint: str,
    insecure: bool,
    insecure_skip_verify: bool,
    ca_cert_file_path: typing.Optional[str],
    console_endpoint: typing.Optional[str],
    command: typing.Optional[typing.List[str]],
    proxy_command: typing.Optional[typing.List[str]],
    client_id: typing.Optional[str],
    client_credentials_secret: typing.Optional[str],
    scopes: List[str],
    auth_mode: AuthType,
    audience: typing.Optional[str],
    rpc_retries: int,
    http_proxy_url: typing.Optional[str],
):

Methods

auto()

def auto(
    config_file: typing.Optional[typing.Union[str, ConfigFile]],
):

Reads from Config file, and overrides from Environment variables. Refer to ConfigEntry for details

for_endpoint()

def for_endpoint(
    endpoint: str,
    insecure: bool,
):

flytekit.clients.raw.ProjectListRequest

A ProtocolMessage

flytekit.clients.raw.RawSynchronousFlyteClient

This is a thin synchronous wrapper around the auto-generated GRPC stubs for communicating with the admin service.

This client should be usable regardless of environment in which this is used. In other words, configurations should be explicit as opposed to inferred from the environment or a configuration file. To create a client,

.. code-block:: python

from flytekit.configuration import PlatformConfig RawSynchronousFlyteClient(PlatformConfig(endpoint=“a.b.com”, insecure=True)) # or SynchronousFlyteClient(PlatformConfig(endpoint=“a.b.com”, insecure=True))

def RawSynchronousFlyteClient(
    cfg: PlatformConfig,
    kwargs,
):

Initializes a gRPC channel to the given Flyte Admin service.

Methods

create_download_link()

def create_download_link(
    create_download_link_request: _dataproxy_pb2.CreateDownloadLinkRequest,
):

create_download_location()

def create_download_location(
    create_download_location_request: _dataproxy_pb2.CreateDownloadLocationRequest,
):

create_execution()

def create_execution(
    create_execution_request,
):

This will create an execution for the given execution spec.

create_launch_plan()

def create_launch_plan(
    launch_plan_create_request,
):

This will create a launch plan definition in the Admin database. Once successful, the launch plan object can be retrieved via the client or viewed via the UI or command-line interfaces.

.. note ::

Overwrites are not supported so any request for a given project, domain, name, and version that exists in the database must match the existing definition exactly. This also means that as long as the request remains identical, calling this method multiple times will result in success.

create_task()

def create_task(
    task_create_request,
):

This will create a task definition in the Admin database. Once successful, the task object can be retrieved via the client or viewed via the UI or command-line interfaces.

.. note ::

Overwrites are not supported so any request for a given project, domain, name, and version that exists in the database must match the existing definition exactly. This also means that as long as the request remains identical, calling this method multiple times will result in success.

create_upload_location()

def create_upload_location(
    create_upload_location_request: _dataproxy_pb2.CreateUploadLocationRequest,
):

Get a signed url to be used during fast registration

create_workflow()

def create_workflow(
    workflow_create_request,
):

This will create a workflow definition in the Admin database. Once successful, the workflow object can be retrieved via the client or viewed via the UI or command-line interfaces.

.. note ::

Overwrites are not supported so any request for a given project, domain, name, and version that exists in the database must match the existing definition exactly. This also means that as long as the request remains identical, calling this method multiple times will result in success.

get_active_launch_plan()

def get_active_launch_plan(
    active_launch_plan_request,
):

Retrieves a launch plan entity.

get_domains()

def get_domains()

This will return a list of domains registered with the Flyte Admin Service

get_execution()

def get_execution(
    get_object_request,
):

Returns an execution of a workflow entity.

get_execution_data()

def get_execution_data(
    get_execution_data_request,
):

Returns signed URLs to LiteralMap blobs for an execution’s inputs and outputs (when available).

get_execution_metrics()

def get_execution_metrics(
    get_execution_metrics_request,
):

Returns metrics partitioning and categorizing the workflow execution time-series.

get_launch_plan()

def get_launch_plan(
    object_get_request,
):

Retrieves a launch plan entity.

get_node_execution()

def get_node_execution(
    node_execution_request,
):

get_node_execution_data()

def get_node_execution_data(
    get_node_execution_data_request,
):

Returns signed URLs to LiteralMap blobs for a node execution’s inputs and outputs (when available).

get_project_domain_attributes()

def get_project_domain_attributes(
    project_domain_attributes_get_request,
):

This fetches the attributes for a project and domain registered with the Flyte Admin Service

get_task()

def get_task(
    get_object_request,
):

This returns a single task for a given identifier.

get_task_execution()

def get_task_execution(
    task_execution_request,
):

get_task_execution_data()

def get_task_execution_data(
    get_task_execution_data_request,
):

Returns signed URLs to LiteralMap blobs for a task execution’s inputs and outputs (when available).

get_workflow()

def get_workflow(
    get_object_request,
):

This returns a single workflow for a given identifier.

get_workflow_attributes()

def get_workflow_attributes(
    workflow_attributes_get_request,
):

This fetches the attributes for a project, domain, and workflow registered with the Flyte Admin Service

list_active_launch_plans_paginated()

def list_active_launch_plans_paginated(
    active_launch_plan_list_request,
):

Lists Active Launch Plans for a given (project, domain)

list_executions_paginated()

def list_executions_paginated(
    resource_list_request,
):

Lists the executions for a given identifier.

list_launch_plan_ids_paginated()

def list_launch_plan_ids_paginated(
    identifier_list_request,
):

Lists launch plan named identifiers for a given project and domain.

list_launch_plans_paginated()

def list_launch_plans_paginated(
    resource_list_request,
):

Lists Launch Plans for a given Identifier (project, domain, name)

list_matchable_attributes()

def list_matchable_attributes(
    matchable_attributes_list_request,
):

This fetches the attributes for a specific resource type registered with the Flyte Admin Service

list_node_executions_for_task_paginated()

def list_node_executions_for_task_paginated(
    node_execution_for_task_list_request,
):

list_node_executions_paginated()

def list_node_executions_paginated(
    node_execution_list_request,
):

list_projects()

def list_projects(
    project_list_request: typing.Optional[ProjectListRequest],
):

This will return a list of the projects registered with the Flyte Admin Service

list_signals()

def list_signals(
    signal_list_request: SignalListRequest,
):

This lists signals

list_task_executions_paginated()

def list_task_executions_paginated(
    task_execution_list_request,
):

list_task_ids_paginated()

def list_task_ids_paginated(
    identifier_list_request,
):

This returns a page of identifiers for the tasks for a given project and domain. Filters can also be specified.

.. note ::

The name field in the TaskListRequest is ignored.

.. note ::

This is a paginated API. Use the token field in the request to specify a page offset token. The user of the API is responsible for providing this token.

.. note ::

If entries are added to the database between requests for different pages, it is possible to receive entries on the second page that also appeared on the first.

list_tasks_paginated()

def list_tasks_paginated(
    resource_list_request,
):

This returns a page of task metadata for tasks in a given project and domain. Optionally, specifying a name will limit the results to only tasks with that name in the given project and domain.

.. note ::

This is a paginated API. Use the token field in the request to specify a page offset token. The user of the API is responsible for providing this token.

.. note ::

If entries are added to the database between requests for different pages, it is possible to receive entries on the second page that also appeared on the first.

list_workflow_ids_paginated()

def list_workflow_ids_paginated(
    identifier_list_request,
):

This returns a page of identifiers for the workflows for a given project and domain. Filters can also be specified.

.. note ::

The name field in the WorkflowListRequest is ignored.

.. note ::

This is a paginated API. Use the token field in the request to specify a page offset token. The user of the API is responsible for providing this token.

.. note ::

If entries are added to the database between requests for different pages, it is possible to receive entries on the second page that also appeared on the first.

list_workflows_paginated()

def list_workflows_paginated(
    resource_list_request,
):

This returns a page of workflow meta-information for workflows in a given project and domain. Optionally, specifying a name will limit the results to only workflows with that name in the given project and domain.

.. note ::

This is a paginated API. Use the token field in the request to specify a page offset token. The user of the API is responsible for providing this token.

.. note ::

If entries are added to the database between requests for different pages, it is possible to receive entries on the second page that also appeared on the first.

recover_execution()

def recover_execution(
    recover_execution_request,
):

This will recreate an execution with the same spec as the one belonging to the given execution identifier.

register_project()

def register_project(
    project_register_request,
):

Registers a project along with a set of domains.

relaunch_execution()

def relaunch_execution(
    relaunch_execution_request,
):

set_signal()

def set_signal(
    signal_set_request: SignalSetRequest,
):

This sets a signal

terminate_execution()

def terminate_execution(
    terminate_execution_request,
):

update_launch_plan()

def update_launch_plan(
    update_request,
):

Allows updates to a launch plan at a given identifier. Currently, a launch plan may only have it’s state switched between ACTIVE and INACTIVE.

update_named_entity()

def update_named_entity(
    update_named_entity_request,
):

update_project()

def update_project(
    project,
):

Update an existing project specified by id.

update_project_domain_attributes()

def update_project_domain_attributes(
    project_domain_attributes_update_request,
):

This updates the attributes for a project and domain registered with the Flyte Admin Service

update_workflow_attributes()

def update_workflow_attributes(
    workflow_attributes_update_request,
):

This updates the attributes for a project, domain, and workflow registered with the Flyte Admin Service

with_root_certificate()

def with_root_certificate(
    cfg: PlatformConfig,
    root_cert_file: str,
):

Properties

flytekit.clients.raw.SignalList

A ProtocolMessage

flytekit.clients.raw.SignalListRequest

A ProtocolMessage

flytekit.clients.raw.SignalSetRequest

A ProtocolMessage

flytekit.clients.raw.SignalSetResponse

A ProtocolMessage