Documentation
¶
Overview ¶
Package ext Provides Fetch,Update and Delete extensions to the admin API's whose interface directly relates to flytectl commands
Index ¶
- func IsNotFoundError(err error) bool
- type AdminDeleterExtClient
- func (a *AdminDeleterExtClient) AdminServiceClient() service.AdminServiceClient
- func (a *AdminDeleterExtClient) DeleteProjectAttributes(ctx context.Context, project string, rsType admin.MatchableResource) error
- func (a *AdminDeleterExtClient) DeleteProjectDomainAttributes(ctx context.Context, project, domain string, rsType admin.MatchableResource) error
- func (a *AdminDeleterExtClient) DeleteWorkflowAttributes(ctx context.Context, project, domain, name string, ...) error
- type AdminDeleterExtInterface
- type AdminFetcherExtClient
- func (a *AdminFetcherExtClient) AdminServiceClient() service.AdminServiceClient
- func (a *AdminFetcherExtClient) FetchAllVerOfLP(ctx context.Context, lpName, project, domain string, filter filters.Filters) ([]*admin.LaunchPlan, error)
- func (a *AdminFetcherExtClient) FetchAllVerOfTask(ctx context.Context, name, project, domain string, filter filters.Filters) ([]*admin.Task, error)
- func (a *AdminFetcherExtClient) FetchAllVerOfWorkflow(ctx context.Context, workflowName, project, domain string, ...) ([]*admin.Workflow, error)
- func (a *AdminFetcherExtClient) FetchAllWorkflows(ctx context.Context, project, domain string, filter filters.Filters) ([]*admin.NamedEntity, error)
- func (a *AdminFetcherExtClient) FetchExecution(ctx context.Context, name, project, domain string) (*admin.Execution, error)
- func (a *AdminFetcherExtClient) FetchLPLatestVersion(ctx context.Context, name, project, domain string, filter filters.Filters) (*admin.LaunchPlan, error)
- func (a *AdminFetcherExtClient) FetchLPVersion(ctx context.Context, name, version, project, domain string) (*admin.LaunchPlan, error)
- func (a *AdminFetcherExtClient) FetchNodeExecutionData(ctx context.Context, nodeID, execName, project, domain string) (*admin.NodeExecutionGetDataResponse, error)
- func (a *AdminFetcherExtClient) FetchNodeExecutionDetails(ctx context.Context, name, project, domain, uniqueParentID string) (*admin.NodeExecutionList, error)
- func (a *AdminFetcherExtClient) FetchProjectAttributes(ctx context.Context, project string, rsType admin.MatchableResource) (*admin.ProjectAttributesGetResponse, error)
- func (a *AdminFetcherExtClient) FetchProjectDomainAttributes(ctx context.Context, project, domain string, rsType admin.MatchableResource) (*admin.ProjectDomainAttributesGetResponse, error)
- func (a *AdminFetcherExtClient) FetchTaskExecutionsOnNode(ctx context.Context, nodeID, execName, project, domain string) (*admin.TaskExecutionList, error)
- func (a *AdminFetcherExtClient) FetchTaskLatestVersion(ctx context.Context, name, project, domain string, filter filters.Filters) (*admin.Task, error)
- func (a *AdminFetcherExtClient) FetchTaskVersion(ctx context.Context, name, version, project, domain string) (*admin.Task, error)
- func (a *AdminFetcherExtClient) FetchWorkflowAttributes(ctx context.Context, project, domain, name string, ...) (*admin.WorkflowAttributesGetResponse, error)
- func (a *AdminFetcherExtClient) FetchWorkflowLatestVersion(ctx context.Context, name, project, domain string, filter filters.Filters) (*admin.Workflow, error)
- func (a *AdminFetcherExtClient) FetchWorkflowVersion(ctx context.Context, name, version, project, domain string) (*admin.Workflow, error)
- func (a *AdminFetcherExtClient) GetProjectByID(ctx context.Context, projectID string) (*admin.Project, error)
- func (a *AdminFetcherExtClient) ListExecution(ctx context.Context, project, domain string, filter filters.Filters) (*admin.ExecutionList, error)
- func (a *AdminFetcherExtClient) ListProjects(ctx context.Context, filter filters.Filters) (*admin.Projects, error)
- type AdminFetcherExtInterface
- type AdminUpdaterExtClient
- func (a *AdminUpdaterExtClient) AdminServiceClient() service.AdminServiceClient
- func (a *AdminUpdaterExtClient) UpdateProjectAttributes(ctx context.Context, project string, matchingAttr *admin.MatchingAttributes) error
- func (a *AdminUpdaterExtClient) UpdateProjectDomainAttributes(ctx context.Context, project, domain string, ...) error
- func (a *AdminUpdaterExtClient) UpdateWorkflowAttributes(ctx context.Context, project, domain, name string, ...) error
- type AdminUpdaterExtInterface
- type NotFoundError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsNotFoundError ¶ added in v0.7.0
Types ¶
type AdminDeleterExtClient ¶
type AdminDeleterExtClient struct {
AdminClient service.AdminServiceClient
}
AdminDeleterExtClient is used for interacting with extended features used for deleting/archiving data in admin service
func (*AdminDeleterExtClient) AdminServiceClient ¶
func (a *AdminDeleterExtClient) AdminServiceClient() service.AdminServiceClient
func (*AdminDeleterExtClient) DeleteProjectAttributes ¶ added in v0.6.23
func (a *AdminDeleterExtClient) DeleteProjectAttributes(ctx context.Context, project string, rsType admin.MatchableResource) error
func (*AdminDeleterExtClient) DeleteProjectDomainAttributes ¶
func (a *AdminDeleterExtClient) DeleteProjectDomainAttributes(ctx context.Context, project, domain string, rsType admin.MatchableResource) error
func (*AdminDeleterExtClient) DeleteWorkflowAttributes ¶
func (a *AdminDeleterExtClient) DeleteWorkflowAttributes(ctx context.Context, project, domain, name string, rsType admin.MatchableResource) error
type AdminDeleterExtInterface ¶
type AdminDeleterExtInterface interface {
AdminServiceClient() service.AdminServiceClient
// DeleteWorkflowAttributes deletes workflow attributes within a project, domain for a particular matchable resource
DeleteWorkflowAttributes(ctx context.Context, project, domain, name string, rsType admin.MatchableResource) error
// DeleteProjectDomainAttributes deletes project domain attributes for a particular matchable resource
DeleteProjectDomainAttributes(ctx context.Context, project, domain string, rsType admin.MatchableResource) error
// DeleteProjectAttributes deletes project attributes for a particular matchable resource
DeleteProjectAttributes(ctx context.Context, project string, rsType admin.MatchableResource) error
}
AdminDeleterExtInterface Interface for exposing the update capabilities from the admin
type AdminFetcherExtClient ¶
type AdminFetcherExtClient struct {
AdminClient service.AdminServiceClient
}
AdminFetcherExtClient is used for interacting with extended features used for fetching data from admin service
func (*AdminFetcherExtClient) AdminServiceClient ¶
func (a *AdminFetcherExtClient) AdminServiceClient() service.AdminServiceClient
func (*AdminFetcherExtClient) FetchAllVerOfLP ¶
func (a *AdminFetcherExtClient) FetchAllVerOfLP(ctx context.Context, lpName, project, domain string, filter filters.Filters) ([]*admin.LaunchPlan, error)
FetchAllVerOfLP fetches all the versions for give launch plan name
func (*AdminFetcherExtClient) FetchAllVerOfTask ¶
func (*AdminFetcherExtClient) FetchAllVerOfWorkflow ¶
func (a *AdminFetcherExtClient) FetchAllVerOfWorkflow(ctx context.Context, workflowName, project, domain string, filter filters.Filters) ([]*admin.Workflow, error)
FetchAllVerOfWorkflow fetches all the versions for give workflow name
func (*AdminFetcherExtClient) FetchAllWorkflows ¶ added in v0.5.12
func (a *AdminFetcherExtClient) FetchAllWorkflows(ctx context.Context, project, domain string, filter filters.Filters) ([]*admin.NamedEntity, error)
FetchAllWorkflows fetches all workflows in project domain
func (*AdminFetcherExtClient) FetchExecution ¶
func (*AdminFetcherExtClient) FetchLPLatestVersion ¶
func (a *AdminFetcherExtClient) FetchLPLatestVersion(ctx context.Context, name, project, domain string, filter filters.Filters) (*admin.LaunchPlan, error)
FetchLPLatestVersion fetches latest version for give launch plan name
func (*AdminFetcherExtClient) FetchLPVersion ¶
func (a *AdminFetcherExtClient) FetchLPVersion(ctx context.Context, name, version, project, domain string) (*admin.LaunchPlan, error)
FetchLPVersion fetches particular version of launch plan
func (*AdminFetcherExtClient) FetchNodeExecutionData ¶ added in v0.2.13
func (a *AdminFetcherExtClient) FetchNodeExecutionData(ctx context.Context, nodeID, execName, project, domain string) (*admin.NodeExecutionGetDataResponse, error)
func (*AdminFetcherExtClient) FetchNodeExecutionDetails ¶ added in v0.1.34
func (a *AdminFetcherExtClient) FetchNodeExecutionDetails(ctx context.Context, name, project, domain, uniqueParentID string) (*admin.NodeExecutionList, error)
func (*AdminFetcherExtClient) FetchProjectAttributes ¶ added in v0.6.23
func (a *AdminFetcherExtClient) FetchProjectAttributes(ctx context.Context, project string, rsType admin.MatchableResource) (*admin.ProjectAttributesGetResponse, error)
func (*AdminFetcherExtClient) FetchProjectDomainAttributes ¶
func (a *AdminFetcherExtClient) FetchProjectDomainAttributes(ctx context.Context, project, domain string, rsType admin.MatchableResource) (*admin.ProjectDomainAttributesGetResponse, error)
func (*AdminFetcherExtClient) FetchTaskExecutionsOnNode ¶ added in v0.1.34
func (a *AdminFetcherExtClient) FetchTaskExecutionsOnNode(ctx context.Context, nodeID, execName, project, domain string) (*admin.TaskExecutionList, error)
func (*AdminFetcherExtClient) FetchTaskLatestVersion ¶
func (*AdminFetcherExtClient) FetchTaskVersion ¶
func (*AdminFetcherExtClient) FetchWorkflowAttributes ¶
func (a *AdminFetcherExtClient) FetchWorkflowAttributes(ctx context.Context, project, domain, name string, rsType admin.MatchableResource) (*admin.WorkflowAttributesGetResponse, error)
func (*AdminFetcherExtClient) FetchWorkflowLatestVersion ¶
func (a *AdminFetcherExtClient) FetchWorkflowLatestVersion(ctx context.Context, name, project, domain string, filter filters.Filters) (*admin.Workflow, error)
FetchWorkflowLatestVersion fetches latest version for given workflow name
func (*AdminFetcherExtClient) FetchWorkflowVersion ¶
func (a *AdminFetcherExtClient) FetchWorkflowVersion(ctx context.Context, name, version, project, domain string) (*admin.Workflow, error)
FetchWorkflowVersion fetches particular version of workflow
func (*AdminFetcherExtClient) GetProjectByID ¶ added in v0.7.0
func (*AdminFetcherExtClient) ListExecution ¶ added in v0.1.10
func (a *AdminFetcherExtClient) ListExecution(ctx context.Context, project, domain string, filter filters.Filters) (*admin.ExecutionList, error)
func (*AdminFetcherExtClient) ListProjects ¶ added in v0.1.10
type AdminFetcherExtInterface ¶
type AdminFetcherExtInterface interface {
AdminServiceClient() service.AdminServiceClient
// FetchExecution fetches the execution based on name, project, domain
FetchExecution(ctx context.Context, name, project, domain string) (*admin.Execution, error)
// FetchNodeExecutionDetails fetches the node execution details based on execution name, project, domain, uniqueParentId
FetchNodeExecutionDetails(ctx context.Context, name, project, domain, uniqueParentID string) (*admin.NodeExecutionList, error)
// FetchNodeExecutionData fetches the node execution data based on nodeId, execution name, project, domain
FetchNodeExecutionData(ctx context.Context, nodeID, execName, project, domain string) (*admin.NodeExecutionGetDataResponse, error)
// FetchTaskExecutionsOnNode fetches task execution on a node , for give execution name, project, domain
FetchTaskExecutionsOnNode(ctx context.Context, nodeID, execName, project, domain string) (*admin.TaskExecutionList, error)
// ListExecution fetches the all versions of based on name, project, domain
ListExecution(ctx context.Context, project, domain string, filter filters.Filters) (*admin.ExecutionList, error)
// FetchAllVerOfLP fetches all versions of launch plan in a project, domain
FetchAllVerOfLP(ctx context.Context, lpName, project, domain string, filter filters.Filters) ([]*admin.LaunchPlan, error)
// FetchLPLatestVersion fetches latest version of launch plan in a project, domain
FetchLPLatestVersion(ctx context.Context, name, project, domain string, filter filters.Filters) (*admin.LaunchPlan, error)
// FetchLPVersion fetches particular version of launch plan in a project, domain
FetchLPVersion(ctx context.Context, name, version, project, domain string) (*admin.LaunchPlan, error)
// FetchAllVerOfTask fetches all versions of task in a project, domain
FetchAllVerOfTask(ctx context.Context, name, project, domain string, filter filters.Filters) ([]*admin.Task, error)
// FetchTaskLatestVersion fetches latest version of task in a project, domain
FetchTaskLatestVersion(ctx context.Context, name, project, domain string, filter filters.Filters) (*admin.Task, error)
// FetchTaskVersion fetches particular version of task in a project, domain
FetchTaskVersion(ctx context.Context, name, version, project, domain string) (*admin.Task, error)
// FetchAllWorkflows fetches all workflows in project domain
FetchAllWorkflows(ctx context.Context, project, domain string, filter filters.Filters) ([]*admin.NamedEntity, error)
// FetchAllVerOfWorkflow fetches all versions of task in a project, domain
FetchAllVerOfWorkflow(ctx context.Context, name, project, domain string, filter filters.Filters) ([]*admin.Workflow, error)
// FetchWorkflowLatestVersion fetches latest version of workflow in a project, domain
FetchWorkflowLatestVersion(ctx context.Context, name, project, domain string, filter filters.Filters) (*admin.Workflow, error)
// FetchWorkflowVersion fetches particular version of workflow in a project, domain
FetchWorkflowVersion(ctx context.Context, name, version, project, domain string) (*admin.Workflow, error)
// FetchWorkflowAttributes fetches workflow attributes particular resource type in a project, domain and workflow
FetchWorkflowAttributes(ctx context.Context, project, domain, name string, rsType admin.MatchableResource) (*admin.WorkflowAttributesGetResponse, error)
// FetchProjectDomainAttributes fetches project domain attributes particular resource type in a project, domain
FetchProjectDomainAttributes(ctx context.Context, project, domain string, rsType admin.MatchableResource) (*admin.ProjectDomainAttributesGetResponse, error)
// FetchProjectAttributes fetches project attributes particular resource type in a project
FetchProjectAttributes(ctx context.Context, project string, rsType admin.MatchableResource) (*admin.ProjectAttributesGetResponse, error)
// ListProjects fetches all projects
ListProjects(ctx context.Context, filter filters.Filters) (*admin.Projects, error)
// GetProjectByID fetches a single project by its identifier. If project does not exist, an error will be returned
GetProjectByID(ctx context.Context, projectID string) (*admin.Project, error)
}
AdminFetcherExtInterface Interface for exposing the fetch capabilities from the admin and also allow this to be injectable into other modules. eg : create execution which requires to fetch launchplan details to construct the execution spec.
type AdminUpdaterExtClient ¶
type AdminUpdaterExtClient struct {
AdminClient service.AdminServiceClient
}
AdminUpdaterExtClient is used for interacting with extended features used for updating data in admin service
func (*AdminUpdaterExtClient) AdminServiceClient ¶
func (a *AdminUpdaterExtClient) AdminServiceClient() service.AdminServiceClient
func (*AdminUpdaterExtClient) UpdateProjectAttributes ¶ added in v0.6.23
func (a *AdminUpdaterExtClient) UpdateProjectAttributes(ctx context.Context, project string, matchingAttr *admin.MatchingAttributes) error
func (*AdminUpdaterExtClient) UpdateProjectDomainAttributes ¶
func (a *AdminUpdaterExtClient) UpdateProjectDomainAttributes(ctx context.Context, project, domain string, matchingAttr *admin.MatchingAttributes) error
func (*AdminUpdaterExtClient) UpdateWorkflowAttributes ¶
func (a *AdminUpdaterExtClient) UpdateWorkflowAttributes(ctx context.Context, project, domain, name string, matchingAttr *admin.MatchingAttributes) error
type AdminUpdaterExtInterface ¶
type AdminUpdaterExtInterface interface {
AdminServiceClient() service.AdminServiceClient
// UpdateWorkflowAttributes updates workflow attributes within a project, domain for a particular matchable resource
UpdateWorkflowAttributes(ctx context.Context, project, domain, name string, matchingAttr *admin.MatchingAttributes) error
// UpdateProjectDomainAttributes updates project domain attributes for a particular matchable resource
UpdateProjectDomainAttributes(ctx context.Context, project, domain string, matchingAttr *admin.MatchingAttributes) error
// UpdateProjectAttributes updates project attributes for a particular matchable resource
UpdateProjectAttributes(ctx context.Context, project string, matchingAttr *admin.MatchingAttributes) error
}
AdminUpdaterExtInterface Interface for exposing the update capabilities from the admin
type NotFoundError ¶ added in v0.7.0
type NotFoundError struct {
Target string
}
func NewNotFoundError ¶ added in v0.7.0
func NewNotFoundError(targetFormat string, formatArgs ...any) *NotFoundError
func (*NotFoundError) Error ¶ added in v0.7.0
func (err *NotFoundError) Error() string