# flytekit.clients.raw

## Directory

### Classes

| Class | Description |
|-|-|
| [`RawSynchronousFlyteClient`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.clients.raw/page.md#flytekitclientsrawrawsynchronousflyteclient) | This is a thin synchronous wrapper around the auto-generated GRPC stubs for communicating with the admin service. |

## 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,

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

### Parameters

```python
class RawSynchronousFlyteClient(
    cfg: PlatformConfig,
    kwargs,
)
```
Initializes a gRPC channel to the given Flyte Admin service.

| Parameter | Type | Description |
|-|-|-|
| `cfg` | `PlatformConfig` | |
| `kwargs` | `**kwargs` | |

### Properties

| Property | Type | Description |
|-|-|-|
| `url` | `None` |  |

### Methods

| Method | Description |
|-|-|
| [`create_download_link()`](#create_download_link) |  |
| [`create_download_location()`](#create_download_location) |  |
| [`create_execution()`](#create_execution) | This will create an execution for the given execution spec. |
| [`create_launch_plan()`](#create_launch_plan) | This will create a launch plan definition in the Admin database. |
| [`create_task()`](#create_task) | This will create a task definition in the Admin database. |
| [`create_upload_location()`](#create_upload_location) | Get a signed url to be used during fast registration. |
| [`create_workflow()`](#create_workflow) | This will create a workflow definition in the Admin database. |
| [`get_active_launch_plan()`](#get_active_launch_plan) | Retrieves a launch plan entity. |
| [`get_domains()`](#get_domains) | This will return a list of domains registered with the Flyte Admin Service. |
| [`get_execution()`](#get_execution) | Returns an execution of a workflow entity. |
| [`get_execution_data()`](#get_execution_data) | Returns signed URLs to LiteralMap blobs for an execution's inputs and outputs (when available). |
| [`get_execution_metrics()`](#get_execution_metrics) | Returns metrics partitioning and categorizing the workflow execution time-series. |
| [`get_launch_plan()`](#get_launch_plan) | Retrieves a launch plan entity. |
| [`get_node_execution()`](#get_node_execution) |  |
| [`get_node_execution_data()`](#get_node_execution_data) | Returns signed URLs to LiteralMap blobs for a node execution's inputs and outputs (when available). |
| [`get_project_domain_attributes()`](#get_project_domain_attributes) | This fetches the attributes for a project and domain registered with the Flyte Admin Service. |
| [`get_task()`](#get_task) | This returns a single task for a given identifier. |
| [`get_task_execution()`](#get_task_execution) |  |
| [`get_task_execution_data()`](#get_task_execution_data) | Returns signed URLs to LiteralMap blobs for a task execution's inputs and outputs (when available). |
| [`get_workflow()`](#get_workflow) | This returns a single workflow for a given identifier. |
| [`get_workflow_attributes()`](#get_workflow_attributes) | This fetches the attributes for a project, domain, and workflow registered with the Flyte Admin Service. |
| [`list_active_launch_plans_paginated()`](#list_active_launch_plans_paginated) | Lists Active Launch Plans for a given (project, domain). |
| [`list_executions_paginated()`](#list_executions_paginated) | Lists the executions for a given identifier. |
| [`list_launch_plan_ids_paginated()`](#list_launch_plan_ids_paginated) | Lists launch plan named identifiers for a given project and domain. |
| [`list_launch_plans_paginated()`](#list_launch_plans_paginated) | Lists Launch Plans for a given Identifier (project, domain, name). |
| [`list_matchable_attributes()`](#list_matchable_attributes) | This fetches the attributes for a specific resource type registered with the Flyte Admin Service. |
| [`list_node_executions_for_task_paginated()`](#list_node_executions_for_task_paginated) |  |
| [`list_node_executions_paginated()`](#list_node_executions_paginated) |  |
| [`list_projects()`](#list_projects) | This will return a list of the projects registered with the Flyte Admin Service. |
| [`list_signals()`](#list_signals) | This lists signals. |
| [`list_task_executions_paginated()`](#list_task_executions_paginated) |  |
| [`list_task_ids_paginated()`](#list_task_ids_paginated) | This returns a page of identifiers for the tasks for a given project and domain. |
| [`list_tasks_paginated()`](#list_tasks_paginated) | This returns a page of task metadata for tasks in a given project and domain. |
| [`list_workflow_ids_paginated()`](#list_workflow_ids_paginated) | This returns a page of identifiers for the workflows for a given project and domain. |
| [`list_workflows_paginated()`](#list_workflows_paginated) | This returns a page of workflow meta-information for workflows in a given project and domain. |
| [`recover_execution()`](#recover_execution) | This will recreate an execution with the same spec as the one belonging to the given execution identifier. |
| [`register_project()`](#register_project) | Registers a project along with a set of domains. |
| [`relaunch_execution()`](#relaunch_execution) |  |
| [`set_signal()`](#set_signal) | This sets a signal. |
| [`terminate_execution()`](#terminate_execution) |  |
| [`update_launch_plan()`](#update_launch_plan) | Allows updates to a launch plan at a given identifier. |
| [`update_named_entity()`](#update_named_entity) |  |
| [`update_project()`](#update_project) | Update an existing project specified by id. |
| [`update_project_domain_attributes()`](#update_project_domain_attributes) | This updates the attributes for a project and domain registered with the Flyte Admin Service. |
| [`update_workflow_attributes()`](#update_workflow_attributes) | This updates the attributes for a project, domain, and workflow registered with the Flyte Admin Service. |
| [`with_root_certificate()`](#with_root_certificate) |  |

#### create_download_link()

```python
def create_download_link(
    create_download_link_request: _dataproxy_pb2.CreateDownloadLinkRequest,
) -> _dataproxy_pb2.CreateDownloadLinkResponse
```
| Parameter | Type | Description |
|-|-|-|
| `create_download_link_request` | `_dataproxy_pb2.CreateDownloadLinkRequest` | |

#### create_download_location()

```python
def create_download_location(
    create_download_location_request: _dataproxy_pb2.CreateDownloadLocationRequest,
) -> _dataproxy_pb2.CreateDownloadLocationResponse
```
| Parameter | Type | Description |
|-|-|-|
| `create_download_location_request` | `_dataproxy_pb2.CreateDownloadLocationRequest` | |

#### create_execution()

```python
def create_execution(
    create_execution_request,
)
```
This will create an execution for the given execution spec.

| Parameter | Type | Description |
|-|-|-|
| `create_execution_request` |  | |

**Returns:** flyteidl.admin.execution_pb2.ExecutionCreateResponse

#### create_launch_plan()

```python
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.

    launch plan is found, this exception is raised.  The client might choose to ignore this exception because
    the identical launch plan is already registered.

| Parameter | Type | Description |
|-|-|-|
| `launch_plan_create_request` |  | |

**Returns:** flyteidl.admin.launch_plan_pb2.LaunchPlanCreateResponse

**Raises**

| Exception | Description |
|-|-|
| `flytekit.common.exceptions.user.FlyteEntityAlreadyExistsException` | If an identical version of the |
| `grpc.RpcError` |  |

#### create_task()

```python
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.

    is found, this exception is raised.  The client might choose to ignore this exception because the identical
    task is already registered.

| Parameter | Type | Description |
|-|-|-|
| `task_create_request` |  | |

**Returns:** flyteidl.admin.task_pb2.TaskCreateResponse

**Raises**

| Exception | Description |
|-|-|
| `flytekit.common.exceptions.user.FlyteEntityAlreadyExistsException` | If an identical version of the task |
| `grpc.RpcError` |  |

#### create_upload_location()

```python
def create_upload_location(
    create_upload_location_request: _dataproxy_pb2.CreateUploadLocationRequest,
) -> _dataproxy_pb2.CreateUploadLocationResponse
```
Get a signed url to be used during fast registration

| Parameter | Type | Description |
|-|-|-|
| `create_upload_location_request` | `_dataproxy_pb2.CreateUploadLocationRequest` | |

**Returns:** flyteidl.service.dataproxy_pb2.CreateUploadLocationResponse

#### create_workflow()

```python
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.

    workflow is found, this exception is raised.  The client might choose to ignore this exception because the
    identical workflow is already registered.

| Parameter | Type | Description |
|-|-|-|
| `workflow_create_request` |  | |

**Returns:** flyteidl.admin.workflow_pb2.WorkflowCreateResponse

**Raises**

| Exception | Description |
|-|-|
| `flytekit.common.exceptions.user.FlyteEntityAlreadyExistsException` | If an identical version of the |
| `grpc.RpcError` |  |

#### get_active_launch_plan()

```python
def get_active_launch_plan(
    active_launch_plan_request,
)
```
Retrieves a launch plan entity.

| Parameter | Type | Description |
|-|-|-|
| `active_launch_plan_request` |  | |

**Returns:** flyteidl.admin.launch_plan_pb2.LaunchPlan

#### get_domains()

```python
def get_domains()
```
This will return a list of domains registered with the Flyte Admin Service

**Returns:** flyteidl.admin.project_pb2.GetDomainsResponse

#### get_execution()

```python
def get_execution(
    get_object_request,
)
```
Returns an execution of a workflow entity.

| Parameter | Type | Description |
|-|-|-|
| `get_object_request` |  | |

**Returns:** flyteidl.admin.execution_pb2.Execution

#### get_execution_data()

```python
def get_execution_data(
    get_execution_data_request,
)
```
Returns signed URLs to LiteralMap blobs for an execution's inputs and outputs (when available).

| Parameter | Type | Description |
|-|-|-|
| `get_execution_data_request` |  | |

**Returns:** flyteidl.admin.execution_pb2.WorkflowExecutionGetDataResponse

#### get_execution_metrics()

```python
def get_execution_metrics(
    get_execution_metrics_request,
)
```
Returns metrics partitioning and categorizing the workflow execution time-series.

| Parameter | Type | Description |
|-|-|-|
| `get_execution_metrics_request` |  | |

**Returns:** flyteidl.admin.execution_pb2.WorkflowExecutionGetMetricsResponse

#### get_launch_plan()

```python
def get_launch_plan(
    object_get_request,
)
```
Retrieves a launch plan entity.

| Parameter | Type | Description |
|-|-|-|
| `object_get_request` |  | |

**Returns:** flyteidl.admin.launch_plan_pb2.LaunchPlan

#### get_node_execution()

```python
def get_node_execution(
    node_execution_request,
)
```
| Parameter | Type | Description |
|-|-|-|
| `node_execution_request` |  | |

**Returns:** flyteidl.admin.node_execution_pb2.NodeExecution

#### get_node_execution_data()

```python
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).

| Parameter | Type | Description |
|-|-|-|
| `get_node_execution_data_request` |  | |

**Returns:** flyteidl.admin.node_execution_pb2.NodeExecutionGetDataResponse

#### get_project_domain_attributes()

```python
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

| Parameter | Type | Description |
|-|-|-|
| `project_domain_attributes_get_request` |  | |

**Returns:** flyteidl.admin.ProjectDomainAttributesGetResponse

#### get_task()

```python
def get_task(
    get_object_request,
)
```
This returns a single task for a given identifier.

| Parameter | Type | Description |
|-|-|-|
| `get_object_request` |  | |

**Returns:** flyteidl.admin.task_pb2.Task

**Raises**

| Exception | Description |
|-|-|
|  | TODO |

#### get_task_execution()

```python
def get_task_execution(
    task_execution_request,
)
```
| Parameter | Type | Description |
|-|-|-|
| `task_execution_request` |  | |

**Returns:** flyteidl.admin.task_execution_pb2.TaskExecution

#### get_task_execution_data()

```python
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).

| Parameter | Type | Description |
|-|-|-|
| `get_task_execution_data_request` |  | |

**Returns:** flyteidl.admin.task_execution_pb2.TaskExecutionGetDataResponse

#### get_workflow()

```python
def get_workflow(
    get_object_request,
)
```
This returns a single workflow for a given identifier.

| Parameter | Type | Description |
|-|-|-|
| `get_object_request` |  | |

**Returns:** flyteidl.admin.workflow_pb2.Workflow

**Raises**

| Exception | Description |
|-|-|
|  | TODO |

#### get_workflow_attributes()

```python
def get_workflow_attributes(
    workflow_attributes_get_request,
)
```
This fetches the attributes for a project, domain, and workflow registered with the Flyte Admin Service

| Parameter | Type | Description |
|-|-|-|
| `workflow_attributes_get_request` |  | |

**Returns:** flyteidl.admin.WorkflowAttributesGetResponse

#### list_active_launch_plans_paginated()

```python
def list_active_launch_plans_paginated(
    active_launch_plan_list_request,
)
```
Lists Active Launch Plans for a given (project, domain)

| Parameter | Type | Description |
|-|-|-|
| `active_launch_plan_list_request` |  | |

**Returns:** flyteidl.admin.launch_plan_pb2.LaunchPlanList

#### list_executions_paginated()

```python
def list_executions_paginated(
    resource_list_request,
)
```
Lists the executions for a given identifier.

| Parameter | Type | Description |
|-|-|-|
| `resource_list_request` |  | |

**Returns:** flyteidl.admin.execution_pb2.ExecutionList

#### list_launch_plan_ids_paginated()

```python
def list_launch_plan_ids_paginated(
    identifier_list_request,
)
```
Lists launch plan named identifiers for a given project and domain.

| Parameter | Type | Description |
|-|-|-|
| `identifier_list_request` |  | |

**Returns:** flyteidl.admin.common_pb2.NamedEntityIdentifierList

#### list_launch_plans_paginated()

```python
def list_launch_plans_paginated(
    resource_list_request,
)
```
Lists Launch Plans for a given Identifier (project, domain, name)

| Parameter | Type | Description |
|-|-|-|
| `resource_list_request` |  | |

**Returns:** flyteidl.admin.launch_plan_pb2.LaunchPlanList

#### list_matchable_attributes()

```python
def list_matchable_attributes(
    matchable_attributes_list_request,
)
```
This fetches the attributes for a specific resource type registered with the Flyte Admin Service

| Parameter | Type | Description |
|-|-|-|
| `matchable_attributes_list_request` |  | |

**Returns:** flyteidl.admin.ListMatchableAttributesResponse

#### list_node_executions_for_task_paginated()

```python
def list_node_executions_for_task_paginated(
    node_execution_for_task_list_request,
)
```
| Parameter | Type | Description |
|-|-|-|
| `node_execution_for_task_list_request` |  | |

**Returns:** flyteidl.admin.node_execution_pb2.NodeExecutionList

#### list_node_executions_paginated()

```python
def list_node_executions_paginated(
    node_execution_list_request,
)
```
| Parameter | Type | Description |
|-|-|-|
| `node_execution_list_request` |  | |

**Returns:** flyteidl.admin.node_execution_pb2.NodeExecutionList

#### list_projects()

```python
def list_projects(
    project_list_request: typing.Optional[ProjectListRequest],
)
```
This will return a list of the projects registered with the Flyte Admin Service

| Parameter | Type | Description |
|-|-|-|
| `project_list_request` | `typing.Optional[ProjectListRequest]` | |

**Returns:** flyteidl.admin.project_pb2.Projects

#### list_signals()

```python
def list_signals(
    signal_list_request: SignalListRequest,
) -> SignalList
```
This lists signals

| Parameter | Type | Description |
|-|-|-|
| `signal_list_request` | `SignalListRequest` | |

#### list_task_executions_paginated()

```python
def list_task_executions_paginated(
    task_execution_list_request,
)
```
| Parameter | Type | Description |
|-|-|-|
| `task_execution_list_request` |  | |

**Returns:** flyteidl.admin.task_execution_pb2.TaskExecutionList

#### list_task_ids_paginated()

```python
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.

| Parameter | Type | Description |
|-|-|-|
| `identifier_list_request` |  | |

**Returns:** flyteidl.admin.common_pb2.NamedEntityIdentifierList

**Raises**

| Exception | Description |
|-|-|
|  | TODO |

#### list_tasks_paginated()

```python
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.

| Parameter | Type | Description |
|-|-|-|
| `resource_list_request` |  | |

**Returns:** flyteidl.admin.task_pb2.TaskList

**Raises**

| Exception | Description |
|-|-|
|  | TODO |

#### list_workflow_ids_paginated()

```python
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.

| Parameter | Type | Description |
|-|-|-|
| `identifier_list_request` |  | |

**Returns:** flyteidl.admin.common_pb2.NamedEntityIdentifierList

**Raises**

| Exception | Description |
|-|-|
|  | TODO |

#### list_workflows_paginated()

```python
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.

| Parameter | Type | Description |
|-|-|-|
| `resource_list_request` |  | |

**Returns:** flyteidl.admin.workflow_pb2.WorkflowList

**Raises**

| Exception | Description |
|-|-|
|  | TODO |

#### recover_execution()

```python
def recover_execution(
    recover_execution_request,
)
```
This will recreate an execution with the same spec as the one belonging to the given execution identifier.

| Parameter | Type | Description |
|-|-|-|
| `recover_execution_request` |  | |

**Returns:** flyteidl.admin.execution_pb2.ExecutionRecoverResponse

#### register_project()

```python
def register_project(
    project_register_request,
)
```
Registers a project along with a set of domains.

| Parameter | Type | Description |
|-|-|-|
| `project_register_request` |  | |

**Returns:** flyteidl.admin.project_pb2.ProjectRegisterResponse

#### relaunch_execution()

```python
def relaunch_execution(
    relaunch_execution_request,
)
```
| Parameter | Type | Description |
|-|-|-|
| `relaunch_execution_request` |  | |

**Returns:** flyteidl.admin.execution_pb2.ExecutionCreateResponse

#### set_signal()

```python
def set_signal(
    signal_set_request: SignalSetRequest,
) -> SignalSetResponse
```
This sets a signal

| Parameter | Type | Description |
|-|-|-|
| `signal_set_request` | `SignalSetRequest` | |

#### terminate_execution()

```python
def terminate_execution(
    terminate_execution_request,
)
```
| Parameter | Type | Description |
|-|-|-|
| `terminate_execution_request` |  | |

**Returns:** flyteidl.admin.execution_pb2.TerminateExecutionResponse

#### update_launch_plan()

```python
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.

| Parameter | Type | Description |
|-|-|-|
| `update_request` |  | |

**Returns:** flyteidl.admin.launch_plan_pb2.LaunchPlanUpdateResponse

#### update_named_entity()

```python
def update_named_entity(
    update_named_entity_request,
)
```
| Parameter | Type | Description |
|-|-|-|
| `update_named_entity_request` |  | |

**Returns:** flyteidl.admin.common_pb2.NamedEntityUpdateResponse

#### update_project()

```python
def update_project(
    project,
)
```
Update an existing project specified by id.

| Parameter | Type | Description |
|-|-|-|
| `project` |  | |

**Returns:** flyteidl.admin.project_pb2.ProjectUpdateResponse

#### update_project_domain_attributes()

```python
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

| Parameter | Type | Description |
|-|-|-|
| `project_domain_attributes_update_request` |  | |

**Returns:** flyteidl.admin.ProjectDomainAttributesUpdateResponse

#### update_workflow_attributes()

```python
def update_workflow_attributes(
    workflow_attributes_update_request,
)
```
This updates the attributes for a project, domain, and workflow registered with the Flyte Admin Service

| Parameter | Type | Description |
|-|-|-|
| `workflow_attributes_update_request` |  | |

**Returns:** flyteidl.admin.WorkflowAttributesUpdateResponse

#### with_root_certificate()

```python
def with_root_certificate(
    cfg: PlatformConfig,
    root_cert_file: str,
) -> RawSynchronousFlyteClient
```
| Parameter | Type | Description |
|-|-|-|
| `cfg` | `PlatformConfig` | |
| `root_cert_file` | `str` | |

---
**Source**: https://github.com/unionai/unionai-docs/blob/main/content/api-reference/flytekit-sdk/packages/flytekit.clients.raw.md
**HTML**: https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.clients.raw/