1.16.16

flytekit.extend.backend.connector_service

Directory

Classes

Class Description
AsyncConnectorService
ConnectorMetadataService
SyncConnectorService

Methods

Method Description
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() 

def record_connector_metrics(
    func: typing.Callable,
)
Parameter Type Description
func typing.Callable

flytekit.extend.backend.connector_service.AsyncConnectorService

Methods

Method Description
CreateTask()
DeleteTask()
GetTask()
GetTaskLogs() GetTaskLogs returns task execution logs, if available.
GetTaskMetrics() GetTaskMetrics returns one or more task execution metrics, if available.

CreateTask() 

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() 

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() 

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() 

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() 

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() Fetch a :ref:`ref_flyteidl.
ListAgents() Fetch a list of :ref:`ref_flyteidl.

GetAgent() 

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() 

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 streams the create request and inputs to the agent service and streams the outputs back.

ExecuteTaskSync() 

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