# flytekit.extend.backend.connector_service

## Directory

### Classes

| Class | Description |
|-|-|
| [`AsyncConnectorService`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.extend.backend.connector_service/page.md#flytekitextendbackendconnector_serviceasyncconnectorservice) |  |
| [`ConnectorMetadataService`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.extend.backend.connector_service/page.md#flytekitextendbackendconnector_serviceconnectormetadataservice) |  |
| [`SyncConnectorService`](https://www.union.ai/docs/v1/union/api-reference/flytekit-sdk/packages/flytekit.extend.backend.connector_service/page.md#flytekitextendbackendconnector_servicesyncconnectorservice) |  |

### Methods

| Method | Description |
|-|-|
| [`record_connector_metrics()`](#record_connector_metrics) |  |

### Variables

| Property | Type | Description |
|-|-|-|
| `create_operation` | `str` |  |
| `delete_operation` | `str` |  |
| `do_operation` | `str` |  |
| `get_operation` | `str` |  |
| `metric_prefix` | `str` |  |

## Methods

#### record_connector_metrics()

```python
def record_connector_metrics(
    func: typing.Callable,
)
```
| Parameter | Type | Description |
|-|-|-|
| `func` | `typing.Callable` | |

## flytekit.extend.backend.connector_service.AsyncConnectorService

### Methods

| Method | Description |
|-|-|
| [`CreateTask()`](#createtask) |  |
| [`DeleteTask()`](#deletetask) |  |
| [`GetTask()`](#gettask) |  |
| [`GetTaskLogs()`](#gettasklogs) | GetTaskLogs returns task execution logs, if available. |
| [`GetTaskMetrics()`](#gettaskmetrics) | GetTaskMetrics returns one or more task execution metrics, if available. |

#### CreateTask()

```python
def CreateTask(
    request: typing.Union[flyteidl.admin.agent_pb2.CreateTaskRequest, flyteidl.admin.agent_pb2.GetTaskRequest, flyteidl.admin.agent_pb2.DeleteTaskRequest],
    context: grpc.ServicerContext,
    args,
    kwargs,
)
```
| Parameter | Type | Description |
|-|-|-|
| `request` | `typing.Union[flyteidl.admin.agent_pb2.CreateTaskRequest, flyteidl.admin.agent_pb2.GetTaskRequest, flyteidl.admin.agent_pb2.DeleteTaskRequest]` | |
| `context` | `grpc.ServicerContext` | |
| `args` | `*args` | |
| `kwargs` | `**kwargs` | |

#### DeleteTask()

```python
def DeleteTask(
    request: typing.Union[flyteidl.admin.agent_pb2.CreateTaskRequest, flyteidl.admin.agent_pb2.GetTaskRequest, flyteidl.admin.agent_pb2.DeleteTaskRequest],
    context: grpc.ServicerContext,
    args,
    kwargs,
)
```
| Parameter | Type | Description |
|-|-|-|
| `request` | `typing.Union[flyteidl.admin.agent_pb2.CreateTaskRequest, flyteidl.admin.agent_pb2.GetTaskRequest, flyteidl.admin.agent_pb2.DeleteTaskRequest]` | |
| `context` | `grpc.ServicerContext` | |
| `args` | `*args` | |
| `kwargs` | `**kwargs` | |

#### GetTask()

```python
def GetTask(
    request: typing.Union[flyteidl.admin.agent_pb2.CreateTaskRequest, flyteidl.admin.agent_pb2.GetTaskRequest, flyteidl.admin.agent_pb2.DeleteTaskRequest],
    context: grpc.ServicerContext,
    args,
    kwargs,
)
```
| Parameter | Type | Description |
|-|-|-|
| `request` | `typing.Union[flyteidl.admin.agent_pb2.CreateTaskRequest, flyteidl.admin.agent_pb2.GetTaskRequest, flyteidl.admin.agent_pb2.DeleteTaskRequest]` | |
| `context` | `grpc.ServicerContext` | |
| `args` | `*args` | |
| `kwargs` | `**kwargs` | |

#### GetTaskLogs()

```python
def GetTaskLogs(
    request: flyteidl.admin.agent_pb2.GetTaskLogsRequest,
    context: grpc.ServicerContext,
) -> flyteidl.admin.agent_pb2.GetTaskLogsResponse
```
GetTaskLogs returns task execution logs, if available.
        
| Parameter | Type | Description |
|-|-|-|
| `request` | `flyteidl.admin.agent_pb2.GetTaskLogsRequest` | |
| `context` | `grpc.ServicerContext` | |

#### GetTaskMetrics()

```python
def GetTaskMetrics(
    request: flyteidl.admin.agent_pb2.GetTaskMetricsRequest,
    context: grpc.ServicerContext,
) -> flyteidl.admin.agent_pb2.GetTaskMetricsResponse
```
GetTaskMetrics returns one or more task execution metrics, if available.

Errors include
* OutOfRange if metrics are not available for the specified task time range
* various other errors

| Parameter | Type | Description |
|-|-|-|
| `request` | `flyteidl.admin.agent_pb2.GetTaskMetricsRequest` | |
| `context` | `grpc.ServicerContext` | |

## flytekit.extend.backend.connector_service.ConnectorMetadataService

### Methods

| Method | Description |
|-|-|
| [`GetAgent()`](#getagent) | Fetch a :ref:`ref_flyteidl. |
| [`ListAgents()`](#listagents) | Fetch a list of :ref:`ref_flyteidl. |

#### GetAgent()

```python
def GetAgent(
    request: flyteidl.admin.agent_pb2.GetAgentRequest,
    context: grpc.ServicerContext,
) -> flyteidl.admin.agent_pb2.GetAgentResponse
```
Fetch a :ref:`ref_flyteidl.admin.Agent` definition.
        
| Parameter | Type | Description |
|-|-|-|
| `request` | `flyteidl.admin.agent_pb2.GetAgentRequest` | |
| `context` | `grpc.ServicerContext` | |

#### ListAgents()

```python
def ListAgents(
    request: flyteidl.admin.agent_pb2.ListAgentsRequest,
    context: grpc.ServicerContext,
) -> flyteidl.admin.agent_pb2.ListAgentsResponse
```
Fetch a list of :ref:`ref_flyteidl.admin.Agent` definitions.
        
| Parameter | Type | Description |
|-|-|-|
| `request` | `flyteidl.admin.agent_pb2.ListAgentsRequest` | |
| `context` | `grpc.ServicerContext` | |

## flytekit.extend.backend.connector_service.SyncConnectorService

### Methods

| Method | Description |
|-|-|
| [`ExecuteTaskSync()`](#executetasksync) | ExecuteTaskSync streams the create request and inputs to the agent service and streams the outputs back. |

#### ExecuteTaskSync()

```python
def ExecuteTaskSync(
    request_iterator: typing.AsyncIterator[flyteidl.admin.agent_pb2.ExecuteTaskSyncRequest],
    context: grpc.ServicerContext,
) -> typing.AsyncIterator[flyteidl.admin.agent_pb2.ExecuteTaskSyncResponse]
```
ExecuteTaskSync streams the create request and inputs to the agent service and streams the outputs back.
        
| Parameter | Type | Description |
|-|-|-|
| `request_iterator` | `typing.AsyncIterator[flyteidl.admin.agent_pb2.ExecuteTaskSyncRequest]` | |
| `context` | `grpc.ServicerContext` | |

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