Plugin

No overview available.

Methods

---

setRegistry()

@classmethod
def setRegistry(
    r: [Registry](registry.md?sid=flyteplugins_go_tasks_plugins_webapi_connector_registry)
)

Sets the registry for the plugin. This method is used to provide the plugin with access to the registry, which manages various components and services.

Parameters

Name	Type	Description
r	[Registry](registry.md?sid=flyteplugins_go_tasks_plugins_webapi_connector_registry)	The Registry instance to be set for the plugin.

---

GetConfig()

@classmethod
def GetConfig() - > webapi.PluginConfig

Retrieves the configuration for the plugin. Callers use this to access the current operational settings of the plugin.

Returns

Type	Description
webapi.PluginConfig	The configuration object for the plugin.

---

ResourceRequirements()

@classmethod
def ResourceRequirements(
    _: context.Context,
    _: webapi.TaskExecutionContextReader
) - > (namespace core.ResourceNamespace, constraints core.ResourceConstraintsSpec, err error)

Determines the resource requirements for a task. This method is used to specify the necessary resources (e.g., CPU, memory) for executing a task within the given context.

Parameters

Name	Type	Description
_	context.Context	The context for the operation, typically used for cancellation and deadlines.
_	webapi.TaskExecutionContextReader	A reader for the task execution context, providing information about the task being executed.

Returns

Type	Description
(namespace core.ResourceNamespace, constraints core.ResourceConstraintsSpec, err error)	A tuple containing the resource namespace, resource constraints specification, and an error if any occurred.

---

Create()

@classmethod
def Create(
    ctx: context.Context,
    taskCtx: webapi.TaskExecutionContextReader
) - > (webapi.ResourceMeta, webapi.Resource, error)

Creates a new resource. This method is invoked to provision a new resource based on the provided context and task execution details.

Parameters

Name	Type	Description
ctx	context.Context	The context for the operation, typically used for cancellation and deadlines.
taskCtx	webapi.TaskExecutionContextReader	A reader for the task execution context, providing details necessary for resource creation.

Returns

Type	Description
(webapi.ResourceMeta, webapi.Resource, error)	A tuple containing the resource metadata, the created resource, and an error if the creation failed.

---

Get()

@classmethod
def Get(
    ctx: context.Context,
    taskCtx: webapi.GetContext
) - > (latest webapi.Resource, err error)

Retrieves the latest state of a resource. Callers use this method to fetch the current status and details of a specific resource.

Parameters

Name	Type	Description
ctx	context.Context	The context for the operation, typically used for cancellation and deadlines.
taskCtx	webapi.GetContext	The context for the get operation, containing identifiers for the resource to be retrieved.

Returns

Type	Description
(latest webapi.Resource, err error)	A tuple containing the latest version of the resource and an error if the retrieval failed.

---

Delete()

@classmethod
def Delete(
    ctx: context.Context,
    taskCtx: webapi.DeleteContext
) - > error

Deletes a resource. This method is used to remove a specified resource from the system.

Parameters

Name	Type	Description
ctx	context.Context	The context for the operation, typically used for cancellation and deadlines.
taskCtx	webapi.DeleteContext	The context for the delete operation, containing identifiers for the resource to be deleted.

Returns

Type	Description
error	An error if the deletion failed, otherwise nil.

---

getEventInfoForConnectorApp()

@classmethod
def getEventInfoForConnectorApp(
    taskCtx: webapi.StatusContext,
    resource: [ResourceWrapper](resourcewrapper.md?sid=flyteplugins_go_tasks_plugins_webapi_connector_resourcewrapper)
) - > []*flyteIdl.TaskLog, error

Retrieves event information for a connector application. This method is used internally to gather task logs related to a specific connector application and resource.

Parameters

Name	Type	Description
taskCtx	webapi.StatusContext	The status context providing information about the task's current state.
resource	[ResourceWrapper](resourcewrapper.md?sid=flyteplugins_go_tasks_plugins_webapi_connector_resourcewrapper)	The wrapper around the resource for which event information is needed.

Returns

Type	Description
[]*flyteIdl.TaskLog, error	A slice of task logs associated with the connector application and an error if retrieval failed.

---

Status()

@classmethod
def Status(
    ctx: context.Context,
    taskCtx: webapi.StatusContext
) - > (phase core.PhaseInfo, err error)

Retrieves the current status of a task. Callers use this method to monitor the progress and state of an ongoing task.

Parameters

Name	Type	Description
ctx	context.Context	The context for the operation, typically used for cancellation and deadlines.
taskCtx	webapi.StatusContext	The status context providing information about the task whose status is being queried.

Returns

Type	Description
(phase core.PhaseInfo, err error)	A tuple containing the current phase information of the task and an error if status retrieval failed.

---

getAsyncConnectorClient()

@classmethod
def getAsyncConnectorClient(
    ctx: context.Context,
    connector: *Deployment
) - > connectorPb.AsyncConnectorServiceClient, error

Obtains an asynchronous client for a connector. This method is used internally to establish a connection to a connector service for asynchronous operations.

Parameters

Name	Type	Description
ctx	context.Context	The context for the operation, typically used for cancellation and deadlines.
connector	*Deployment	The deployment configuration for the connector.

Returns

Type	Description
connectorPb.AsyncConnectorServiceClient, error	An asynchronous connector service client and an error if client creation failed.

---

watchConnectors()

@classmethod
def watchConnectors(
    ctx: context.Context,
    connectorService: *ConnectorService
)

Initiates watching for changes in connectors. This method sets up a mechanism to observe and react to updates or events related to connector services.

Parameters

Name	Type	Description
ctx	context.Context	The context for the operation, typically used for cancellation and deadlines.
connectorService	*ConnectorService	The connector service instance to be watched for changes.

---

getFinalConnector()

@classmethod
def getFinalConnector(
    taskCategory: *connectorPb.TaskCategory,
    cfg: *Config,
    project: string,
    domain: string
) - > *Connector, error

Determines the final connector based on task category, configuration, project, and domain. This method is used to resolve and retrieve the appropriate connector instance for a given set of parameters.

Parameters

Name	Type	Description
taskCategory	*connectorPb.TaskCategory	The category of the task, used to identify the type of connector needed.
cfg	*Config	The plugin configuration, providing general settings.
project	string	The project identifier associated with the task.
domain	string	The domain identifier associated with the task.

Returns

Type	Description
*Connector, error	The resolved connector instance and an error if the connector could not be determined.

---