flyteadmin

package
v1.5.21 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 27, 2023 License: Apache-2.0 Imports: 21 Imported by: 0

README ¶

Go API client for flyteadmin

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: version not set
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./flyteadmin"

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AdminServiceApi CreateExecution Post /api/v1/executions Triggers the creation of a :ref:`ref_flyteidl.admin.Execution`
AdminServiceApi CreateLaunchPlan Post /api/v1/launch_plans Create and upload a :ref:`ref_flyteidl.admin.LaunchPlan` definition
AdminServiceApi CreateNodeEvent Post /api/v1/events/nodes Indicates a :ref:`ref_flyteidl.event.NodeExecutionEvent` has occurred.
AdminServiceApi CreateTask Post /api/v1/tasks Create and upload a :ref:`ref_flyteidl.admin.Task` definition
AdminServiceApi CreateTaskEvent Post /api/v1/events/tasks Indicates a :ref:`ref_flyteidl.event.TaskExecutionEvent` has occurred.
AdminServiceApi CreateWorkflow Post /api/v1/workflows Create and upload a :ref:`ref_flyteidl.admin.Workflow` definition
AdminServiceApi CreateWorkflowEvent Post /api/v1/events/workflows Indicates a :ref:`ref_flyteidl.event.WorkflowExecutionEvent` has occurred.
AdminServiceApi DeleteProjectAttributes Delete /api/v1/project_attributes/{project} Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
AdminServiceApi DeleteProjectDomainAttributes Delete /api/v1/project_domain_attributes/{project}/{domain} Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
AdminServiceApi DeleteWorkflowAttributes Delete /api/v1/workflow_attributes/{project}/{domain}/{workflow} Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
AdminServiceApi GetActiveLaunchPlan Get /api/v1/active_launch_plans/{id.project}/{id.domain}/{id.name} Fetch the active version of a :ref:`ref_flyteidl.admin.LaunchPlan`.
AdminServiceApi GetDescriptionEntity Get /api/v1/description_entities/{id.resource_type}/{id.project}/{id.domain}/{id.name}/{id.version} Fetch a :ref:`ref_flyteidl.admin.DescriptionEntity` object.
AdminServiceApi GetExecution Get /api/v1/executions/{id.project}/{id.domain}/{id.name} Fetches a :ref:`ref_flyteidl.admin.Execution`.
AdminServiceApi GetExecutionData Get /api/v1/data/executions/{id.project}/{id.domain}/{id.name} Fetches input and output data for a :ref:`ref_flyteidl.admin.Execution`.
AdminServiceApi GetExecutionMetrics Get /api/v1/metrics/executions/{id.project}/{id.domain}/{id.name} Fetches runtime metrics for a :ref:`ref_flyteidl.admin.Execution`.
AdminServiceApi GetLaunchPlan Get /api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version} Fetch a :ref:`ref_flyteidl.admin.LaunchPlan` definition.
AdminServiceApi GetNamedEntity Get /api/v1/named_entities/{resource_type}/{id.project}/{id.domain}/{id.name} Returns a :ref:`ref_flyteidl.admin.NamedEntity` object.
AdminServiceApi GetNodeExecution Get /api/v1/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id} Fetches a :ref:`ref_flyteidl.admin.NodeExecution`.
AdminServiceApi GetNodeExecutionData Get /api/v1/data/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id} Fetches input and output data for a :ref:`ref_flyteidl.admin.NodeExecution`.
AdminServiceApi GetProjectAttributes Get /api/v1/project_attributes/{project} Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
AdminServiceApi GetProjectDomainAttributes Get /api/v1/project_domain_attributes/{project}/{domain} Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
AdminServiceApi GetTask Get /api/v1/tasks/{id.project}/{id.domain}/{id.name}/{id.version} Fetch a :ref:`ref_flyteidl.admin.Task` definition.
AdminServiceApi GetTaskExecution Get /api/v1/task_executions/{id.node_execution_id.execution_id.project}/{id.node_execution_id.execution_id.domain}/{id.node_execution_id.execution_id.name}/{id.node_execution_id.node_id}/{id.task_id.project}/{id.task_id.domain}/{id.task_id.name}/{id.task_id.version}/{id.retry_attempt} Fetches a :ref:`ref_flyteidl.admin.TaskExecution`.
AdminServiceApi GetTaskExecutionData Get /api/v1/data/task_executions/{id.node_execution_id.execution_id.project}/{id.node_execution_id.execution_id.domain}/{id.node_execution_id.execution_id.name}/{id.node_execution_id.node_id}/{id.task_id.project}/{id.task_id.domain}/{id.task_id.name}/{id.task_id.version}/{id.retry_attempt} Fetches input and output data for a :ref:`ref_flyteidl.admin.TaskExecution`.
AdminServiceApi GetVersion Get /api/v1/version
AdminServiceApi GetWorkflow Get /api/v1/workflows/{id.project}/{id.domain}/{id.name}/{id.version} Fetch a :ref:`ref_flyteidl.admin.Workflow` definition.
AdminServiceApi GetWorkflowAttributes Get /api/v1/workflow_attributes/{project}/{domain}/{workflow} Fetches custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.
AdminServiceApi ListActiveLaunchPlans Get /api/v1/active_launch_plans/{project}/{domain} List active versions of :ref:`ref_flyteidl.admin.LaunchPlan`.
AdminServiceApi ListDescriptionEntities Get /api/v1/description_entities/{resource_type}/{id.project}/{id.domain}/{id.name} Fetch a list of :ref:`ref_flyteidl.admin.DescriptionEntity` definitions.
AdminServiceApi ListDescriptionEntities2 Get /api/v1/description_entities/{resource_type}/{id.project}/{id.domain} Fetch a list of :ref:`ref_flyteidl.admin.DescriptionEntity` definitions.
AdminServiceApi ListExecutions Get /api/v1/executions/{id.project}/{id.domain} Fetch a list of :ref:`ref_flyteidl.admin.Execution`.
AdminServiceApi ListLaunchPlanIds Get /api/v1/launch_plan_ids/{project}/{domain} Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of launch plan objects.
AdminServiceApi ListLaunchPlans Get /api/v1/launch_plans/{id.project}/{id.domain}/{id.name} Fetch a list of :ref:`ref_flyteidl.admin.LaunchPlan` definitions.
AdminServiceApi ListLaunchPlans2 Get /api/v1/launch_plans/{id.project}/{id.domain} Fetch a list of :ref:`ref_flyteidl.admin.LaunchPlan` definitions.
AdminServiceApi ListMatchableAttributes Get /api/v1/matchable_attributes Lists custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a specific resource type.
AdminServiceApi ListNamedEntities Get /api/v1/named_entities/{resource_type}/{project}/{domain} Returns a list of :ref:`ref_flyteidl.admin.NamedEntity` objects.
AdminServiceApi ListNodeExecutions Get /api/v1/node_executions/{workflow_execution_id.project}/{workflow_execution_id.domain}/{workflow_execution_id.name} Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution`.
AdminServiceApi ListNodeExecutionsForTask Get /api/v1/children/task_executions/{task_execution_id.node_execution_id.execution_id.project}/{task_execution_id.node_execution_id.execution_id.domain}/{task_execution_id.node_execution_id.execution_id.name}/{task_execution_id.node_execution_id.node_id}/{task_execution_id.task_id.project}/{task_execution_id.task_id.domain}/{task_execution_id.task_id.name}/{task_execution_id.task_id.version}/{task_execution_id.retry_attempt} Fetch a list of :ref:`ref_flyteidl.admin.NodeExecution` launched by the reference :ref:`ref_flyteidl.admin.TaskExecution`.
AdminServiceApi ListProjects Get /api/v1/projects Fetches a list of :ref:`ref_flyteidl.admin.Project`
AdminServiceApi ListTaskExecutions Get /api/v1/task_executions/{node_execution_id.execution_id.project}/{node_execution_id.execution_id.domain}/{node_execution_id.execution_id.name}/{node_execution_id.node_id} Fetches a list of :ref:`ref_flyteidl.admin.TaskExecution`.
AdminServiceApi ListTaskIds Get /api/v1/task_ids/{project}/{domain} Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of task objects.
AdminServiceApi ListTasks Get /api/v1/tasks/{id.project}/{id.domain}/{id.name} Fetch a list of :ref:`ref_flyteidl.admin.Task` definitions.
AdminServiceApi ListTasks2 Get /api/v1/tasks/{id.project}/{id.domain} Fetch a list of :ref:`ref_flyteidl.admin.Task` definitions.
AdminServiceApi ListWorkflowIds Get /api/v1/workflow_ids/{project}/{domain} Fetch a list of :ref:`ref_flyteidl.admin.NamedEntityIdentifier` of workflow objects.
AdminServiceApi ListWorkflows Get /api/v1/workflows/{id.project}/{id.domain}/{id.name} Fetch a list of :ref:`ref_flyteidl.admin.Workflow` definitions.
AdminServiceApi ListWorkflows2 Get /api/v1/workflows/{id.project}/{id.domain} Fetch a list of :ref:`ref_flyteidl.admin.Workflow` definitions.
AdminServiceApi RecoverExecution Post /api/v1/executions/recover Recreates a previously-run workflow execution that will only start executing from the last known failure point. In Recover mode, users cannot change any input parameters or update the version of the execution. This is extremely useful to recover from system errors and byzantine faults like - Loss of K8s cluster, bugs in platform or instability, machine failures, downstream system failures (downstream services), or simply to recover executions that failed because of retry exhaustion and should complete if tried again. See :ref:`ref_flyteidl.admin.ExecutionRecoverRequest` for more details.
AdminServiceApi RegisterProject Post /api/v1/projects Registers a :ref:`ref_flyteidl.admin.Project` with the Flyte deployment.
AdminServiceApi RelaunchExecution Post /api/v1/executions/relaunch Triggers the creation of an identical :ref:`ref_flyteidl.admin.Execution`
AdminServiceApi TerminateExecution Delete /api/v1/executions/{id.project}/{id.domain}/{id.name} Terminates an in-progress :ref:`ref_flyteidl.admin.Execution`.
AdminServiceApi UpdateExecution Put /api/v1/executions/{id.project}/{id.domain}/{id.name} Update execution belonging to project domain :ref:`ref_flyteidl.admin.Execution`.
AdminServiceApi UpdateLaunchPlan Put /api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version} Updates the status of a registered :ref:`ref_flyteidl.admin.LaunchPlan`.
AdminServiceApi UpdateNamedEntity Put /api/v1/named_entities/{resource_type}/{id.project}/{id.domain}/{id.name} Updates a :ref:`ref_flyteidl.admin.NamedEntity` object.
AdminServiceApi UpdateProject Put /api/v1/projects/{id} Updates an existing :ref:`ref_flyteidl.admin.Project` flyteidl.admin.Project should be passed but the domains property should be empty; it will be ignored in the handler as domains cannot be updated via this API.
AdminServiceApi UpdateProjectAttributes Put /api/v1/project_attributes/{attributes.project} Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` at the project level
AdminServiceApi UpdateProjectDomainAttributes Put /api/v1/project_domain_attributes/{attributes.project}/{attributes.domain} Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.
AdminServiceApi UpdateWorkflowAttributes Put /api/v1/workflow_attributes/{attributes.project}/{attributes.domain}/{attributes.workflow} Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶ 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶ 

type APIClient struct {
	AdminServiceApi *AdminServiceApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the flyteidl/service/admin.proto API vversion not set In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶ 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶ 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶ 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶ 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶ 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶ 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AdminAbortMetadata ¶ added in v0.16.2 

type AdminAbortMetadata struct {
	// In the case of a user-specified abort, this will pass along the user-supplied cause.
	Cause     string `json:"cause,omitempty"`
	Principal string `json:"principal,omitempty"`
}

Specifies metadata around an aborted workflow execution.

type AdminAnnotations ¶ 

type AdminAnnotations struct {
	// Map of custom annotations to be applied to the execution resource.
	Values map[string]string `json:"values,omitempty"`
}

Annotation values to be applied to an execution resource. In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined to specify how to merge annotations defined at registration and execution time.

type AdminAuth ¶ 

type AdminAuth struct {
	// Defines an optional iam role which will be used for tasks run in executions created with this launch plan.
	AssumableIamRole string `json:"assumable_iam_role,omitempty"`
	// Defines an optional kubernetes service account which will be used for tasks run in executions created with this launch plan.
	KubernetesServiceAccount string `json:"kubernetes_service_account,omitempty"`
}

Defines permissions associated with executions created by this launch plan spec. Use either of these roles when they have permissions required by your workflow execution. Deprecated.

type AdminAuthRole ¶ added in v0.18.15 

type AdminAuthRole struct {
	// Defines an optional iam role which will be used for tasks run in executions created with this launch plan.
	AssumableIamRole string `json:"assumable_iam_role,omitempty"`
	// Defines an optional kubernetes service account which will be used for tasks run in executions created with this launch plan.
	KubernetesServiceAccount string `json:"kubernetes_service_account,omitempty"`
}

Defines permissions associated with executions created by this launch plan spec. Use either of these roles when they have permissions required by your workflow execution. Deprecated.

type AdminClusterAssignment ¶ added in v0.24.2 

type AdminClusterAssignment struct {
	ClusterPoolName string `json:"cluster_pool_name,omitempty"`
}

Encapsulates specifications for routing an execution onto a specific cluster.

type AdminClusterResourceAttributes ¶ added in v0.16.4 

type AdminClusterResourceAttributes struct {
	// Custom resource attributes which will be applied in cluster resource creation (e.g. quotas). Map keys are the *case-sensitive* names of variables in templatized resource files. Map values should be the custom values which get substituted during resource creation.
	Attributes map[string]string `json:"attributes,omitempty"`
}

type AdminCronSchedule ¶ added in v0.18.15 

type AdminCronSchedule struct {
	Schedule string `json:"schedule,omitempty"`
	Offset   string `json:"offset,omitempty"`
}

Options for schedules to run according to a cron expression.

type AdminDescription ¶ added in v1.2.4 

type AdminDescription struct {
	Value    string                  `json:"value,omitempty"`
	Uri      string                  `json:"uri,omitempty"`
	Format   *AdminDescriptionFormat `json:"format,omitempty"`
	IconLink string                  `json:"icon_link,omitempty"`
}

Full user description with formatting preserved. This can be rendered by clients, such as the console or command line tools with in-tact formatting.

type AdminDescriptionEntity ¶ added in v1.2.4 

type AdminDescriptionEntity struct {
	// id represents the unique identifier of the description entity.
	Id *CoreIdentifier `json:"id,omitempty"`
	// One-liner overview of the entity.
	ShortDescription string `json:"short_description,omitempty"`
	// Full user description with formatting preserved.
	LongDescription *AdminDescription `json:"long_description,omitempty"`
	// Optional link to source code used to define this entity.
	SourceCode *AdminSourceCode `json:"source_code,omitempty"`
	// User-specified tags. These are arbitrary and can be used for searching filtering and discovering tasks.
	Tags []string `json:"tags,omitempty"`
}

DescriptionEntity contains detailed description for the task/workflow. Documentation could provide insight into the algorithms, business use case, etc.

type AdminDescriptionEntityList ¶ added in v1.2.4 

type AdminDescriptionEntityList struct {
	// A list of DescriptionEntities returned based on the request.
	DescriptionEntities []AdminDescriptionEntity `json:"descriptionEntities,omitempty"`
	// In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty.
	Token string `json:"token,omitempty"`
}

type AdminDescriptionFormat ¶ added in v1.2.4 

type AdminDescriptionFormat string

AdminDescriptionFormat : - DESCRIPTION_FORMAT_RST: python default documentation - comments is rst 

const (
	AdminDescriptionFormatUNKNOWN  AdminDescriptionFormat = "DESCRIPTION_FORMAT_UNKNOWN"
	AdminDescriptionFormatMARKDOWN AdminDescriptionFormat = "DESCRIPTION_FORMAT_MARKDOWN"
	AdminDescriptionFormatHTML     AdminDescriptionFormat = "DESCRIPTION_FORMAT_HTML"
	AdminDescriptionFormatRST      AdminDescriptionFormat = "DESCRIPTION_FORMAT_RST"
)

List of adminDescriptionFormat

type AdminDomain ¶ 

type AdminDomain struct {
	// Globally unique domain name.
	Id string `json:"id,omitempty"`
	// Display name.
	Name string `json:"name,omitempty"`
}

Namespace within a project commonly used to differentiate between different service instances. e.g. \"production\", \"development\", etc.

type AdminEmailNotification ¶ 

type AdminEmailNotification struct {
	RecipientsEmail []string `json:"recipients_email,omitempty"`
}

Defines an email notification specification.

type AdminEnvs ¶ added in v1.2.10 

type AdminEnvs struct {
	// Map of custom environment variables to be applied to the execution resource.
	Values []CoreKeyValuePair `json:"values,omitempty"`
}

Environment variable values to be applied to an execution resource. In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined to specify how to merge environment variables defined at registration and execution time.

type AdminExecution ¶ 

type AdminExecution struct {
	// Unique identifier of the workflow execution.
	Id *CoreWorkflowExecutionIdentifier `json:"id,omitempty"`
	// User-provided configuration and inputs for launching the execution.
	Spec *AdminExecutionSpec `json:"spec,omitempty"`
	// Execution results.
	Closure *AdminExecutionClosure `json:"closure,omitempty"`
}

A workflow execution represents an instantiated workflow, including all inputs and additional metadata as well as computed results included state, outputs, and duration-based attributes. Used as a response object used in Get and List execution requests.

type AdminExecutionClosure ¶ 

type AdminExecutionClosure struct {
	// Output URI in the case of a successful execution. DEPRECATED. Use GetExecutionData to fetch output data instead.
	Outputs *AdminLiteralMapBlob `json:"outputs,omitempty"`
	// Error information in the case of a failed execution.
	Error_ *CoreExecutionError `json:"error,omitempty"`
	// In the case of a user-specified abort, this will pass along the user-supplied cause.
	AbortCause string `json:"abort_cause,omitempty"`
	// In the case of a user-specified abort, this will pass along the user and their supplied cause.
	AbortMetadata *AdminAbortMetadata `json:"abort_metadata,omitempty"`
	// Raw output data produced by this execution. DEPRECATED. Use GetExecutionData to fetch output data instead.
	OutputData     *CoreLiteralMap `json:"output_data,omitempty"`
	ComputedInputs *CoreLiteralMap `json:"computed_inputs,omitempty"`
	// Most recent recorded phase for the execution.
	Phase *CoreWorkflowExecutionPhase `json:"phase,omitempty"`
	// Reported time at which the execution began running.
	StartedAt time.Time `json:"started_at,omitempty"`
	// The amount of time the execution spent running.
	Duration string `json:"duration,omitempty"`
	// Reported time at which the execution was created.
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Reported time at which the execution was last updated.
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// The notification settings to use after merging the CreateExecutionRequest and the launch plan notification settings. An execution launched with notifications will always prefer that definition to notifications defined statically in a launch plan.
	Notifications []AdminNotification `json:"notifications,omitempty"`
	// Identifies the workflow definition for this execution.
	WorkflowId         *CoreIdentifier                   `json:"workflow_id,omitempty"`
	StateChangeDetails *AdminExecutionStateChangeDetails `json:"state_change_details,omitempty"`
}

type AdminExecutionClusterLabel ¶ added in v0.18.15 

type AdminExecutionClusterLabel struct {
	Value string `json:"value,omitempty"`
}

type AdminExecutionCreateRequest ¶ 

type AdminExecutionCreateRequest struct {
	Project string              `json:"project,omitempty"`
	Domain  string              `json:"domain,omitempty"`
	Name    string              `json:"name,omitempty"`
	Spec    *AdminExecutionSpec `json:"spec,omitempty"`
	Inputs  *CoreLiteralMap     `json:"inputs,omitempty"`
}

Request to launch an execution with the given project, domain and optionally-assigned name.

type AdminExecutionCreateResponse ¶ 

type AdminExecutionCreateResponse struct {
	Id *CoreWorkflowExecutionIdentifier `json:"id,omitempty"`
}

The unique identifier for a successfully created execution. If the name was *not* specified in the create request, this identifier will include a generated name.

type AdminExecutionList ¶ 

type AdminExecutionList struct {
	Executions []AdminExecution `json:"executions,omitempty"`
	// In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty.
	Token string `json:"token,omitempty"`
}

type AdminExecutionMetadata ¶ 

type AdminExecutionMetadata struct {
	Mode *ExecutionMetadataExecutionMode `json:"mode,omitempty"`
	// Identifier of the entity that triggered this execution. For systems using back-end authentication any value set here will be discarded in favor of the authenticated user context.
	Principal string `json:"principal,omitempty"`
	// Indicates the nestedness of this execution. If a user launches a workflow execution, the default nesting is 0. If this execution further launches a workflow (child workflow), the nesting level is incremented by 0 => 1 Generally, if workflow at nesting level k launches a workflow then the child workflow will have nesting = k + 1.
	Nesting int64 `json:"nesting,omitempty"`
	// For scheduled executions, the requested time for execution for this specific schedule invocation.
	ScheduledAt         time.Time                    `json:"scheduled_at,omitempty"`
	ParentNodeExecution *CoreNodeExecutionIdentifier `json:"parent_node_execution,omitempty"`
	// Optional, a reference workflow execution related to this execution. In the case of a relaunch, this references the original workflow execution.
	ReferenceExecution *CoreWorkflowExecutionIdentifier `json:"reference_execution,omitempty"`
	// Optional, platform-specific metadata about the execution. In this the future this may be gated behind an ACL or some sort of authorization.
	SystemMetadata *AdminSystemMetadata `json:"system_metadata,omitempty"`
}

Represents attributes about an execution which are not required to launch the execution but are useful to record. These attributes are assigned at launch time and do not change.

type AdminExecutionQueueAttributes ¶ added in v0.16.4 

type AdminExecutionQueueAttributes struct {
	// Tags used for assigning execution queues for tasks defined within this project.
	Tags []string `json:"tags,omitempty"`
}

type AdminExecutionRecoverRequest ¶ added in v0.19.14 

type AdminExecutionRecoverRequest struct {
	// Identifier of the workflow execution to recover.
	Id   *CoreWorkflowExecutionIdentifier `json:"id,omitempty"`
	Name string                           `json:"name,omitempty"`
	// Additional metadata which will be used to overwrite any metadata in the reference execution when triggering a recovery execution.
	Metadata *AdminExecutionMetadata `json:"metadata,omitempty"`
}

Request to recover the referenced execution.

type AdminExecutionRelaunchRequest ¶ 

type AdminExecutionRelaunchRequest struct {
	Id   *CoreWorkflowExecutionIdentifier `json:"id,omitempty"`
	Name string                           `json:"name,omitempty"`
	// Allows for all cached values of a workflow and its tasks to be overwritten for a single execution. If enabled, all calculations are performed even if cached results would be available, overwriting the stored data once execution finishes successfully.
	OverwriteCache bool `json:"overwrite_cache,omitempty"`
}

Request to relaunch the referenced execution.

type AdminExecutionSpec ¶ 

type AdminExecutionSpec struct {
	LaunchPlan *CoreIdentifier         `json:"launch_plan,omitempty"`
	Inputs     *CoreLiteralMap         `json:"inputs,omitempty"`
	Metadata   *AdminExecutionMetadata `json:"metadata,omitempty"`
	// List of notifications based on Execution status transitions When this list is not empty it is used rather than any notifications defined in the referenced launch plan. When this list is empty, the notifications defined for the launch plan will be applied.
	Notifications *AdminNotificationList `json:"notifications,omitempty"`
	// This should be set to true if all notifications are intended to be disabled for this execution.
	DisableAll bool `json:"disable_all,omitempty"`
	// Labels to apply to the execution resource.
	Labels *AdminLabels `json:"labels,omitempty"`
	// Annotations to apply to the execution resource.
	Annotations *AdminAnnotations `json:"annotations,omitempty"`
	// Optional: security context override to apply this execution.
	SecurityContext *CoreSecurityContext `json:"security_context,omitempty"`
	// Optional: auth override to apply this execution.
	AuthRole *AdminAuthRole `json:"auth_role,omitempty"`
	// Indicates the runtime priority of the execution.
	QualityOfService *CoreQualityOfService `json:"quality_of_service,omitempty"`
	// Controls the maximum number of task nodes that can be run in parallel for the entire workflow. This is useful to achieve fairness. Note: MapTasks are regarded as one unit, and parallelism/concurrency of MapTasks is independent from this.
	MaxParallelism      int32                     `json:"max_parallelism,omitempty"`
	RawOutputDataConfig *AdminRawOutputDataConfig `json:"raw_output_data_config,omitempty"`
	// Controls how to select an available cluster on which this execution should run.
	ClusterAssignment *AdminClusterAssignment `json:"cluster_assignment,omitempty"`
	// Allows for the interruptible flag of a workflow to be overwritten for a single execution. Omitting this field uses the workflow's value as a default. As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper around the bool field.
	Interruptible bool `json:"interruptible,omitempty"`
	// Allows for all cached values of a workflow and its tasks to be overwritten for a single execution. If enabled, all calculations are performed even if cached results would be available, overwriting the stored data once execution finishes successfully.
	OverwriteCache bool `json:"overwrite_cache,omitempty"`
	// Environment variables to be set for the execution.
	Envs *AdminEnvs `json:"envs,omitempty"`
	// Tags to be set for the execution.
	Tags []string `json:"tags,omitempty"`
}

An ExecutionSpec encompasses all data used to launch this execution. The Spec does not change over the lifetime of an execution as it progresses across phase changes.

type AdminExecutionState ¶ added in v0.21.24 

type AdminExecutionState string

AdminExecutionState : The state of the execution is used to control its visibility in the UI/CLI. - EXECUTION_ACTIVE: By default, all executions are considered active. - EXECUTION_ARCHIVED: Archived executions are no longer visible in the UI. 

const (
	AdminExecutionStateACTIVE   AdminExecutionState = "EXECUTION_ACTIVE"
	AdminExecutionStateARCHIVED AdminExecutionState = "EXECUTION_ARCHIVED"
)

List of adminExecutionState

type AdminExecutionStateChangeDetails ¶ added in v0.21.24 

type AdminExecutionStateChangeDetails struct {
	// The state of the execution is used to control its visibility in the UI/CLI.
	State *AdminExecutionState `json:"state,omitempty"`
	// This timestamp represents when the state changed.
	OccurredAt time.Time `json:"occurred_at,omitempty"`
	Principal  string    `json:"principal,omitempty"`
}

type AdminExecutionTerminateRequest ¶ 

type AdminExecutionTerminateRequest struct {
	// Uniquely identifies the individual workflow execution to be terminated.
	Id *CoreWorkflowExecutionIdentifier `json:"id,omitempty"`
	// Optional reason for aborting.
	Cause string `json:"cause,omitempty"`
}

Request to terminate an in-progress execution. This action is irreversible. If an execution is already terminated, this request will simply be a no-op. This request will fail if it references a non-existent execution. If the request succeeds the phase \"ABORTED\" will be recorded for the termination with the optional cause added to the output_result.

type AdminExecutionTerminateResponse ¶ 

type AdminExecutionTerminateResponse struct {
}

type AdminExecutionUpdateRequest ¶ added in v0.21.24 

type AdminExecutionUpdateRequest struct {
	Id    *CoreWorkflowExecutionIdentifier `json:"id,omitempty"`
	State *AdminExecutionState             `json:"state,omitempty"`
}

type AdminExecutionUpdateResponse ¶ added in v0.21.24 

type AdminExecutionUpdateResponse struct {
}

type AdminFixedRate ¶ 

type AdminFixedRate struct {
	Value int64               `json:"value,omitempty"`
	Unit  *AdminFixedRateUnit `json:"unit,omitempty"`
}

Option for schedules run at a certain frequency e.g. every 2 minutes.

type AdminFixedRateUnit ¶ 

type AdminFixedRateUnit string

AdminFixedRateUnit : Represents a frequency at which to run a schedule. 

const (
	AdminFixedRateUnitMINUTE AdminFixedRateUnit = "MINUTE"
	AdminFixedRateUnitHOUR   AdminFixedRateUnit = "HOUR"
	AdminFixedRateUnitDAY    AdminFixedRateUnit = "DAY"
)

List of adminFixedRateUnit

type AdminFlyteUrLs ¶ added in v1.2.10 

type AdminFlyteUrLs struct {
	Inputs  string `json:"inputs,omitempty"`
	Outputs string `json:"outputs,omitempty"`
	Deck    string `json:"deck,omitempty"`
}

These URLs are returned as part of node and task execution data requests.

type AdminGetVersionResponse ¶ added in v0.18.17 

type AdminGetVersionResponse struct {
	ControlPlaneVersion *AdminVersion `json:"control_plane_version,omitempty"`
}

type AdminLabels ¶ 

type AdminLabels struct {
	// Map of custom labels to be applied to the execution resource.
	Values map[string]string `json:"values,omitempty"`
}

Label values to be applied to an execution resource. In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined to specify how to merge labels defined at registration and execution time.

type AdminLaunchPlan ¶ 

type AdminLaunchPlan struct {
	// Uniquely identifies a launch plan entity.
	Id *CoreIdentifier `json:"id,omitempty"`
	// User-provided launch plan details, including reference workflow, inputs and other metadata.
	Spec *AdminLaunchPlanSpec `json:"spec,omitempty"`
	// Values computed by the flyte platform after launch plan registration.
	Closure *AdminLaunchPlanClosure `json:"closure,omitempty"`
}

A LaunchPlan provides the capability to templatize workflow executions. Launch plans simplify associating one or more schedules, inputs and notifications with your workflows. Launch plans can be shared and used to trigger executions with predefined inputs even when a workflow definition doesn't necessarily have a default value for said input.

type AdminLaunchPlanClosure ¶ 

type AdminLaunchPlanClosure struct {
	// Indicate the Launch plan state.
	State           *AdminLaunchPlanState `json:"state,omitempty"`
	ExpectedInputs  *CoreParameterMap     `json:"expected_inputs,omitempty"`
	ExpectedOutputs *CoreVariableMap      `json:"expected_outputs,omitempty"`
	// Time at which the launch plan was created.
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Time at which the launch plan was last updated.
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

Values computed by the flyte platform after launch plan registration. These include expected_inputs required to be present in a CreateExecutionRequest to launch the reference workflow as well timestamp values associated with the launch plan.

type AdminLaunchPlanCreateRequest ¶ 

type AdminLaunchPlanCreateRequest struct {
	// Uniquely identifies a launch plan entity.
	Id *CoreIdentifier `json:"id,omitempty"`
	// User-provided launch plan details, including reference workflow, inputs and other metadata.
	Spec *AdminLaunchPlanSpec `json:"spec,omitempty"`
}

Request to register a launch plan. The included LaunchPlanSpec may have a complete or incomplete set of inputs required to launch a workflow execution. By default all launch plans are registered in state INACTIVE. If you wish to set the state to ACTIVE, you must submit a LaunchPlanUpdateRequest, after you have successfully created a launch plan.

type AdminLaunchPlanCreateResponse ¶ 

type AdminLaunchPlanCreateResponse struct {
}

type AdminLaunchPlanList ¶ 

type AdminLaunchPlanList struct {
	LaunchPlans []AdminLaunchPlan `json:"launch_plans,omitempty"`
	// In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty.
	Token string `json:"token,omitempty"`
}

type AdminLaunchPlanMetadata ¶ 

type AdminLaunchPlanMetadata struct {
	Schedule      *AdminSchedule      `json:"schedule,omitempty"`
	Notifications []AdminNotification `json:"notifications,omitempty"`
}

Additional launch plan attributes included in the LaunchPlanSpec not strictly required to launch the reference workflow.

type AdminLaunchPlanSpec ¶ 

type AdminLaunchPlanSpec struct {
	WorkflowId     *CoreIdentifier          `json:"workflow_id,omitempty"`
	EntityMetadata *AdminLaunchPlanMetadata `json:"entity_metadata,omitempty"`
	// Input values to be passed for the execution. These can be overriden when an execution is created with this launch plan.
	DefaultInputs *CoreParameterMap `json:"default_inputs,omitempty"`
	// Fixed, non-overridable inputs for the Launch Plan. These can not be overriden when an execution is created with this launch plan.
	FixedInputs *CoreLiteralMap `json:"fixed_inputs,omitempty"`
	Role        string          `json:"role,omitempty"`
	// Custom labels to be applied to the execution resource.
	Labels *AdminLabels `json:"labels,omitempty"`
	// Custom annotations to be applied to the execution resource.
	Annotations *AdminAnnotations `json:"annotations,omitempty"`
	// Indicates the permission associated with workflow executions triggered with this launch plan.
	Auth            *AdminAuth           `json:"auth,omitempty"`
	AuthRole        *AdminAuthRole       `json:"auth_role,omitempty"`
	SecurityContext *CoreSecurityContext `json:"security_context,omitempty"`
	// Indicates the runtime priority of the execution.
	QualityOfService *CoreQualityOfService `json:"quality_of_service,omitempty"`
	// Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.).
	RawOutputDataConfig *AdminRawOutputDataConfig `json:"raw_output_data_config,omitempty"`
	// Controls the maximum number of tasknodes that can be run in parallel for the entire workflow. This is useful to achieve fairness. Note: MapTasks are regarded as one unit, and parallelism/concurrency of MapTasks is independent from this.
	MaxParallelism int32 `json:"max_parallelism,omitempty"`
	// Allows for the interruptible flag of a workflow to be overwritten for a single execution. Omitting this field uses the workflow's value as a default. As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper around the bool field.
	Interruptible bool `json:"interruptible,omitempty"`
	// Allows for all cached values of a workflow and its tasks to be overwritten for a single execution. If enabled, all calculations are performed even if cached results would be available, overwriting the stored data once execution finishes successfully.
	OverwriteCache bool `json:"overwrite_cache,omitempty"`
	// Environment variables to be set for the execution.
	Envs *AdminEnvs `json:"envs,omitempty"`
}

User-provided launch plan definition and configuration values.

type AdminLaunchPlanState ¶ 

type AdminLaunchPlanState string

AdminLaunchPlanState : By default any launch plan regardless of state can be used to launch a workflow execution. However, at most one version of a launch plan (e.g. a NamedEntityIdentifier set of shared project, domain and name values) can be active at a time in regards to *schedules*. That is, at most one schedule in a NamedEntityIdentifier group will be observed and trigger executions at a defined cadence. 

const (
	AdminLaunchPlanStateINACTIVE AdminLaunchPlanState = "INACTIVE"
	AdminLaunchPlanStateACTIVE   AdminLaunchPlanState = "ACTIVE"
)

List of adminLaunchPlanState

type AdminLaunchPlanUpdateRequest ¶ 

type AdminLaunchPlanUpdateRequest struct {
	// Identifier of launch plan for which to change state. +required.
	Id *CoreIdentifier `json:"id,omitempty"`
	// Desired state to apply to the launch plan. +required.
	State *AdminLaunchPlanState `json:"state,omitempty"`
}

type AdminLaunchPlanUpdateResponse ¶ 

type AdminLaunchPlanUpdateResponse struct {
}

Purposefully empty, may be populated in the future.

type AdminListMatchableAttributesResponse ¶ added in v0.18.15 

type AdminListMatchableAttributesResponse struct {
	Configurations []AdminMatchableAttributesConfiguration `json:"configurations,omitempty"`
}

type AdminLiteralMapBlob ¶ 

type AdminLiteralMapBlob struct {
	Values *CoreLiteralMap `json:"values,omitempty"`
	Uri    string          `json:"uri,omitempty"`
}

type AdminMatchableAttributesConfiguration ¶ added in v0.18.15 

type AdminMatchableAttributesConfiguration struct {
	Attributes *AdminMatchingAttributes `json:"attributes,omitempty"`
	Domain     string                   `json:"domain,omitempty"`
	Project    string                   `json:"project,omitempty"`
	Workflow   string                   `json:"workflow,omitempty"`
	LaunchPlan string                   `json:"launch_plan,omitempty"`
}

Represents a custom set of attributes applied for either a domain; a domain and project; or domain, project and workflow name. These are used to override system level defaults for kubernetes cluster resource management, default execution values, and more all across different levels of specificity.

type AdminMatchableResource ¶ added in v0.16.5 

type AdminMatchableResource string

AdminMatchableResource : Defines a resource that can be configured by customizable Project-, ProjectDomain- or WorkflowAttributes based on matching tags. - TASK_RESOURCE: Applies to customizable task resource requests and limits. - CLUSTER_RESOURCE: Applies to configuring templated kubernetes cluster resources. - EXECUTION_QUEUE: Configures task and dynamic task execution queue assignment. - EXECUTION_CLUSTER_LABEL: Configures the K8s cluster label to be used for execution to be run - QUALITY_OF_SERVICE_SPECIFICATION: Configures default quality of service when undefined in an execution spec. - PLUGIN_OVERRIDE: Selects configurable plugin implementation behavior for a given task type. - WORKFLOW_EXECUTION_CONFIG: Adds defaults for customizable workflow-execution specifications and overrides. - CLUSTER_ASSIGNMENT: Controls how to select an available cluster on which this execution should run. 

const (
	AdminMatchableResourceTASK_RESOURCE                    AdminMatchableResource = "TASK_RESOURCE"
	AdminMatchableResourceCLUSTER_RESOURCE                 AdminMatchableResource = "CLUSTER_RESOURCE"
	AdminMatchableResourceEXECUTION_QUEUE                  AdminMatchableResource = "EXECUTION_QUEUE"
	AdminMatchableResourceEXECUTION_CLUSTER_LABEL          AdminMatchableResource = "EXECUTION_CLUSTER_LABEL"
	AdminMatchableResourceQUALITY_OF_SERVICE_SPECIFICATION AdminMatchableResource = "QUALITY_OF_SERVICE_SPECIFICATION"
	AdminMatchableResourcePLUGIN_OVERRIDE                  AdminMatchableResource = "PLUGIN_OVERRIDE"
	AdminMatchableResourceWORKFLOW_EXECUTION_CONFIG        AdminMatchableResource = "WORKFLOW_EXECUTION_CONFIG"
	AdminMatchableResourceCLUSTER_ASSIGNMENT               AdminMatchableResource = "CLUSTER_ASSIGNMENT"
)

List of adminMatchableResource

type AdminMatchingAttributes ¶ added in v0.16.4 

type AdminMatchingAttributes struct {
	TaskResourceAttributes    *AdminTaskResourceAttributes    `json:"task_resource_attributes,omitempty"`
	ClusterResourceAttributes *AdminClusterResourceAttributes `json:"cluster_resource_attributes,omitempty"`
	ExecutionQueueAttributes  *AdminExecutionQueueAttributes  `json:"execution_queue_attributes,omitempty"`
	ExecutionClusterLabel     *AdminExecutionClusterLabel     `json:"execution_cluster_label,omitempty"`
	QualityOfService          *CoreQualityOfService           `json:"quality_of_service,omitempty"`
	PluginOverrides           *AdminPluginOverrides           `json:"plugin_overrides,omitempty"`
	WorkflowExecutionConfig   *AdminWorkflowExecutionConfig   `json:"workflow_execution_config,omitempty"`
	ClusterAssignment         *AdminClusterAssignment         `json:"cluster_assignment,omitempty"`
}

Generic container for encapsulating all types of the above attributes messages.

type AdminNamedEntity ¶ added in v0.16.1 

type AdminNamedEntity struct {
	// Resource type of the named entity. One of Task, Workflow or LaunchPlan.
	ResourceType *CoreResourceType           `json:"resource_type,omitempty"`
	Id           *AdminNamedEntityIdentifier `json:"id,omitempty"`
	// Additional metadata around a named entity.
	Metadata *AdminNamedEntityMetadata `json:"metadata,omitempty"`
}

Encapsulates information common to a NamedEntity, a Flyte resource such as a task, workflow or launch plan. A NamedEntity is exclusively identified by its resource type and identifier.

type AdminNamedEntityIdentifier ¶ 

type AdminNamedEntityIdentifier struct {
	// Name of the project the resource belongs to.
	Project string `json:"project,omitempty"`
	// Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.
	Domain string `json:"domain,omitempty"`
	Name   string `json:"name,omitempty"`
}

Encapsulation of fields that identifies a Flyte resource. A Flyte resource can be a task, workflow or launch plan. A resource can internally have multiple versions and is uniquely identified by project, domain, and name.

type AdminNamedEntityIdentifierList ¶ 

type AdminNamedEntityIdentifierList struct {
	// A list of identifiers.
	Entities []AdminNamedEntityIdentifier `json:"entities,omitempty"`
	// In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty.
	Token string `json:"token,omitempty"`
}

Represents a list of NamedEntityIdentifiers.

type AdminNamedEntityList ¶ added in v0.16.1 

type AdminNamedEntityList struct {
	Entities []AdminNamedEntity `json:"entities,omitempty"`
	// In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty.
	Token string `json:"token,omitempty"`
}

Represents a list of NamedEntityIdentifiers.

type AdminNamedEntityMetadata ¶ added in v0.16.1 

type AdminNamedEntityMetadata struct {
	Description string `json:"description,omitempty"`
	// Shared state across all version of the entity At this point in time, only workflow entities can have their state archived.
	State *AdminNamedEntityState `json:"state,omitempty"`
}

Additional metadata around a named entity.

type AdminNamedEntityState ¶ added in v0.18.15 

type AdminNamedEntityState string

AdminNamedEntityState : The status of the named entity is used to control its visibility in the UI. - NAMED_ENTITY_ACTIVE: By default, all named entities are considered active and under development. - NAMED_ENTITY_ARCHIVED: Archived named entities are no longer visible in the UI. - SYSTEM_GENERATED: System generated entities that aren't explicitly created or managed by a user. 

const (
	AdminNamedEntityStateNAMED_ENTITY_ACTIVE   AdminNamedEntityState = "NAMED_ENTITY_ACTIVE"
	AdminNamedEntityStateNAMED_ENTITY_ARCHIVED AdminNamedEntityState = "NAMED_ENTITY_ARCHIVED"
	AdminNamedEntityStateSYSTEM_GENERATED      AdminNamedEntityState = "SYSTEM_GENERATED"
)

List of adminNamedEntityState

type AdminNamedEntityUpdateRequest ¶ added in v0.16.1 

type AdminNamedEntityUpdateRequest struct {
	ResourceType *CoreResourceType           `json:"resource_type,omitempty"`
	Id           *AdminNamedEntityIdentifier `json:"id,omitempty"`
	Metadata     *AdminNamedEntityMetadata   `json:"metadata,omitempty"`
}

Request to set the referenced named entity state to the configured value.

type AdminNamedEntityUpdateResponse ¶ added in v0.16.1 

type AdminNamedEntityUpdateResponse struct {
}

Purposefully empty, may be populated in the future.

type AdminNodeExecutionClosure ¶ 

type AdminNodeExecutionClosure struct {
	// Links to a remotely stored, serialized core.LiteralMap of node execution outputs. DEPRECATED. Use GetNodeExecutionData to fetch output data instead.
	OutputUri string              `json:"output_uri,omitempty"`
	Error_    *CoreExecutionError `json:"error,omitempty"`
	// Raw output data produced by this node execution. DEPRECATED. Use GetNodeExecutionData to fetch output data instead.
	OutputData *CoreLiteralMap `json:"output_data,omitempty"`
	// The last recorded phase for this node execution.
	Phase *CoreNodeExecutionPhase `json:"phase,omitempty"`
	// Time at which the node execution began running.
	StartedAt time.Time `json:"started_at,omitempty"`
	// The amount of time the node execution spent running.
	Duration string `json:"duration,omitempty"`
	// Time at which the node execution was created.
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Time at which the node execution was last updated.
	UpdatedAt            time.Time                          `json:"updated_at,omitempty"`
	WorkflowNodeMetadata *FlyteidladminWorkflowNodeMetadata `json:"workflow_node_metadata,omitempty"`
	TaskNodeMetadata     *FlyteidladminTaskNodeMetadata     `json:"task_node_metadata,omitempty"`
	DeckUri              string                             `json:"deck_uri,omitempty"`
	// dynamic_job_spec_uri is the location of the DynamicJobSpec proto message for a DynamicWorkflow. This is required to correctly recover partially completed executions where the subworkflow has already been compiled.
	DynamicJobSpecUri string `json:"dynamic_job_spec_uri,omitempty"`
}

Container for node execution details and results.

type AdminNodeExecutionEventRequest ¶ 

type AdminNodeExecutionEventRequest struct {
	RequestId string `json:"request_id,omitempty"`
	// Details about the event that occurred.
	Event *EventNodeExecutionEvent `json:"event,omitempty"`
}

Request to send a notification that a node execution event has occurred.

type AdminNodeExecutionEventResponse ¶ 

type AdminNodeExecutionEventResponse struct {
}

type AdminNodeExecutionGetDataResponse ¶ 

type AdminNodeExecutionGetDataResponse struct {
	// Signed url to fetch a core.LiteralMap of node execution inputs. Deprecated: Please use full_inputs instead.
	Inputs *AdminUrlBlob `json:"inputs,omitempty"`
	// Signed url to fetch a core.LiteralMap of node execution outputs. Deprecated: Please use full_outputs instead.
	Outputs *AdminUrlBlob `json:"outputs,omitempty"`
	// Full_inputs will only be populated if they are under a configured size threshold.
	FullInputs *CoreLiteralMap `json:"full_inputs,omitempty"`
	// Full_outputs will only be populated if they are under a configured size threshold.
	FullOutputs *CoreLiteralMap `json:"full_outputs,omitempty"`
	// Optional Workflow closure for a dynamically generated workflow, in the case this node yields a dynamic workflow we return its structure here.
	DynamicWorkflow *FlyteidladminDynamicWorkflowNodeMetadata `json:"dynamic_workflow,omitempty"`
	FlyteUrls       *AdminFlyteUrLs                           `json:"flyte_urls,omitempty"`
}

Response structure for NodeExecutionGetDataRequest which contains inputs and outputs for a node execution.

type AdminNodeExecutionList ¶ 

type AdminNodeExecutionList struct {
	NodeExecutions []FlyteidladminNodeExecution `json:"node_executions,omitempty"`
	// In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty.
	Token string `json:"token,omitempty"`
}

type AdminNodeExecutionMetaData ¶ added in v0.18.15 

type AdminNodeExecutionMetaData struct {
	// Node executions are grouped depending on retries of the parent Retry group is unique within the context of a parent node.
	RetryGroup string `json:"retry_group,omitempty"`
	// Boolean flag indicating if the node has child nodes under it This can be true when a node contains a dynamic workflow which then produces child nodes.
	IsParentNode bool   `json:"is_parent_node,omitempty"`
	SpecNodeId   string `json:"spec_node_id,omitempty"`
	// Boolean flag indicating if the node has contains a dynamic workflow which then produces child nodes. This is to distinguish between subworkflows and dynamic workflows which can both have is_parent_node as true.
	IsDynamic bool `json:"is_dynamic,omitempty"`
}

type AdminNotification ¶ 

type AdminNotification struct {
	Phases    []CoreWorkflowExecutionPhase `json:"phases,omitempty"`
	Email     *AdminEmailNotification      `json:"email,omitempty"`
	PagerDuty *AdminPagerDutyNotification  `json:"pager_duty,omitempty"`
	Slack     *AdminSlackNotification      `json:"slack,omitempty"`
}

Represents a structure for notifications based on execution status. The notification content is configured within flyte admin but can be templatized. Future iterations could expose configuring notifications with custom content.

type AdminNotificationList ¶ 

type AdminNotificationList struct {
	Notifications []AdminNotification `json:"notifications,omitempty"`
}

type AdminPagerDutyNotification ¶ 

type AdminPagerDutyNotification struct {
	RecipientsEmail []string `json:"recipients_email,omitempty"`
}

Defines a pager duty notification specification.

type AdminPluginOverride ¶ added in v0.18.15 

type AdminPluginOverride struct {
	// A predefined yet extensible Task type identifier.
	TaskType string `json:"task_type,omitempty"`
	// A set of plugin ids which should handle tasks of this type instead of the default registered plugin. The list will be tried in order until a plugin is found with that id.
	PluginId []string `json:"plugin_id,omitempty"`
	// Defines the behavior when no plugin from the plugin_id list is not found.
	MissingPluginBehavior *PluginOverrideMissingPluginBehavior `json:"missing_plugin_behavior,omitempty"`
}

This MatchableAttribute configures selecting alternate plugin implementations for a given task type. In addition to an override implementation a selection of fallbacks can be provided or other modes for handling cases where the desired plugin override is not enabled in a given Flyte deployment.

type AdminPluginOverrides ¶ added in v0.18.15 

type AdminPluginOverrides struct {
	Overrides []AdminPluginOverride `json:"overrides,omitempty"`
}

type AdminProject ¶ 

type AdminProject struct {
	// Globally unique project name.
	Id string `json:"id,omitempty"`
	// Display name.
	Name        string        `json:"name,omitempty"`
	Domains     []AdminDomain `json:"domains,omitempty"`
	Description string        `json:"description,omitempty"`
	// Leverage Labels from flyteidl.admin.common.proto to tag projects with ownership information.
	Labels *AdminLabels         `json:"labels,omitempty"`
	State  *ProjectProjectState `json:"state,omitempty"`
}

Top-level namespace used to classify different entities like workflows and executions.

type AdminProjectAttributes ¶ added in v0.16.4 

type AdminProjectAttributes struct {
	// Unique project id for which this set of attributes will be applied.
	Project            string                   `json:"project,omitempty"`
	MatchingAttributes *AdminMatchingAttributes `json:"matching_attributes,omitempty"`
}

type AdminProjectAttributesDeleteRequest ¶ added in v0.16.5 

type AdminProjectAttributesDeleteRequest struct {
	Project      string                  `json:"project,omitempty"`
	ResourceType *AdminMatchableResource `json:"resource_type,omitempty"`
}

type AdminProjectAttributesDeleteResponse ¶ added in v0.16.5 

type AdminProjectAttributesDeleteResponse struct {
}

Purposefully empty, may be populated in the future.

type AdminProjectAttributesGetResponse ¶ added in v0.16.5 

type AdminProjectAttributesGetResponse struct {
	Attributes *AdminProjectAttributes `json:"attributes,omitempty"`
}

type AdminProjectAttributesUpdateRequest ¶ added in v0.16.4 

type AdminProjectAttributesUpdateRequest struct {
	Attributes *AdminProjectAttributes `json:"attributes,omitempty"`
}

type AdminProjectAttributesUpdateResponse ¶ added in v0.16.4 

type AdminProjectAttributesUpdateResponse struct {
}

Purposefully empty, may be populated in the future.

type AdminProjectDomainAttributes ¶ added in v0.16.1 

type AdminProjectDomainAttributes struct {
	// Unique project id for which this set of attributes will be applied.
	Project string `json:"project,omitempty"`
	// Unique domain id for which this set of attributes will be applied.
	Domain             string                   `json:"domain,omitempty"`
	MatchingAttributes *AdminMatchingAttributes `json:"matching_attributes,omitempty"`
}

type AdminProjectDomainAttributesDeleteRequest ¶ added in v0.16.5 

type AdminProjectDomainAttributesDeleteRequest struct {
	Project      string                  `json:"project,omitempty"`
	Domain       string                  `json:"domain,omitempty"`
	ResourceType *AdminMatchableResource `json:"resource_type,omitempty"`
}

type AdminProjectDomainAttributesDeleteResponse ¶ added in v0.16.5 

type AdminProjectDomainAttributesDeleteResponse struct {
}

Purposefully empty, may be populated in the future.

type AdminProjectDomainAttributesGetResponse ¶ added in v0.16.5 

type AdminProjectDomainAttributesGetResponse struct {
	Attributes *AdminProjectDomainAttributes `json:"attributes,omitempty"`
}

type AdminProjectDomainAttributesUpdateRequest ¶ added in v0.16.1 

type AdminProjectDomainAttributesUpdateRequest struct {
	Attributes *AdminProjectDomainAttributes `json:"attributes,omitempty"`
}

type AdminProjectDomainAttributesUpdateResponse ¶ added in v0.16.1 

type AdminProjectDomainAttributesUpdateResponse struct {
}

Purposefully empty, may be populated in the future.

type AdminProjectRegisterRequest ¶ 

type AdminProjectRegisterRequest struct {
	Project *AdminProject `json:"project,omitempty"`
}

type AdminProjectRegisterResponse ¶ 

type AdminProjectRegisterResponse struct {
}

Purposefully empty, may be updated in the future.

type AdminProjectUpdateResponse ¶ added in v0.18.15 

type AdminProjectUpdateResponse struct {
}

Purposefully empty, may be updated in the future.

type AdminProjects ¶ 

type AdminProjects struct {
	Projects []AdminProject `json:"projects,omitempty"`
	// In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty.
	Token string `json:"token,omitempty"`
}

type AdminRawOutputDataConfig ¶ added in v0.18.15 

type AdminRawOutputDataConfig struct {
	OutputLocationPrefix string `json:"output_location_prefix,omitempty"`
}

Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.). See https://github.com/flyteorg/flyte/issues/211 for more background information.

type AdminReason ¶ added in v1.2.10 

type AdminReason struct {
	// occurred_at is the timestamp indicating the instant that this reason happened.
	OccurredAt time.Time `json:"occurred_at,omitempty"`
	// message is the explanation for the most recent phase transition or status update.
	Message string `json:"message,omitempty"`
}

Reason is a single message annotated with a timestamp to indicate the instant the reason occurred.

type AdminSchedule ¶ 

type AdminSchedule struct {
	CronExpression string             `json:"cron_expression,omitempty"`
	Rate           *AdminFixedRate    `json:"rate,omitempty"`
	CronSchedule   *AdminCronSchedule `json:"cron_schedule,omitempty"`
	// Name of the input variable that the kickoff time will be supplied to when the workflow is kicked off.
	KickoffTimeInputArg string `json:"kickoff_time_input_arg,omitempty"`
}

Defines complete set of information required to trigger an execution on a schedule.

type AdminServiceApiService ¶ 

type AdminServiceApiService service

func (*AdminServiceApiService) CreateExecution ¶ 

func (a *AdminServiceApiService) CreateExecution(ctx context.Context, body AdminExecutionCreateRequest) (AdminExecutionCreateResponse, *http.Response, error)

AdminServiceApiService Triggers the creation of a :ref:`ref_flyteidl.admin.Execution`

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return AdminExecutionCreateResponse

func (*AdminServiceApiService) CreateLaunchPlan ¶ 

func (a *AdminServiceApiService) CreateLaunchPlan(ctx context.Context, body AdminLaunchPlanCreateRequest) (AdminLaunchPlanCreateResponse, *http.Response, error)

AdminServiceApiService Create and upload a :ref:`ref_flyteidl.admin.LaunchPlan` definition

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return AdminLaunchPlanCreateResponse

func (*AdminServiceApiService) CreateNodeEvent ¶ 

func (a *AdminServiceApiService) CreateNodeEvent(ctx context.Context, body AdminNodeExecutionEventRequest) (AdminNodeExecutionEventResponse, *http.Response, error)

AdminServiceApiService Indicates a :ref:`ref_flyteidl.event.NodeExecutionEvent` has occurred.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return AdminNodeExecutionEventResponse

func (*AdminServiceApiService) CreateTask ¶ 

func (a *AdminServiceApiService) CreateTask(ctx context.Context, body FlyteidladminTaskCreateRequest) (FlyteidladminTaskCreateResponse, *http.Response, error)

AdminServiceApiService Create and upload a :ref:`ref_flyteidl.admin.Task` definition

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return FlyteidladminTaskCreateResponse

func (*AdminServiceApiService) CreateTaskEvent ¶ 

func (a *AdminServiceApiService) CreateTaskEvent(ctx context.Context, body AdminTaskExecutionEventRequest) (AdminTaskExecutionEventResponse, *http.Response, error)

AdminServiceApiService Indicates a :ref:`ref_flyteidl.event.TaskExecutionEvent` has occurred.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return AdminTaskExecutionEventResponse

func (*AdminServiceApiService) CreateWorkflow ¶ 

func (a *AdminServiceApiService) CreateWorkflow(ctx context.Context, body AdminWorkflowCreateRequest) (AdminWorkflowCreateResponse, *http.Response, error)

AdminServiceApiService Create and upload a :ref:`ref_flyteidl.admin.Workflow` definition

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return AdminWorkflowCreateResponse

func (*AdminServiceApiService) CreateWorkflowEvent ¶ 

func (a *AdminServiceApiService) CreateWorkflowEvent(ctx context.Context, body AdminWorkflowExecutionEventRequest) (AdminWorkflowExecutionEventResponse, *http.Response, error)

AdminServiceApiService Indicates a :ref:`ref_flyteidl.event.WorkflowExecutionEvent` has occurred.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return AdminWorkflowExecutionEventResponse

func (*AdminServiceApiService) DeleteProjectAttributes ¶ added in v0.16.5 

func (a *AdminServiceApiService) DeleteProjectAttributes(ctx context.Context, project string, body AdminProjectAttributesDeleteRequest) (AdminProjectAttributesDeleteResponse, *http.Response, error)

AdminServiceApiService Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param project Unique project id which this set of attributes references. +required
  • @param body

@return AdminProjectAttributesDeleteResponse

func (*AdminServiceApiService) DeleteProjectDomainAttributes ¶ added in v0.16.5 

func (a *AdminServiceApiService) DeleteProjectDomainAttributes(ctx context.Context, project string, domain string, body AdminProjectDomainAttributesDeleteRequest) (AdminProjectDomainAttributesDeleteResponse, *http.Response, error)

AdminServiceApiService Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param project Unique project id which this set of attributes references. +required
  • @param domain Unique domain id which this set of attributes references. +required
  • @param body

@return AdminProjectDomainAttributesDeleteResponse

func (*AdminServiceApiService) DeleteWorkflowAttributes ¶ added in v0.16.5 

func (a *AdminServiceApiService) DeleteWorkflowAttributes(ctx context.Context, project string, domain string, workflow string, body AdminWorkflowAttributesDeleteRequest) (AdminWorkflowAttributesDeleteResponse, *http.Response, error)

AdminServiceApiService Deletes custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param project Unique project id which this set of attributes references. +required
  • @param domain Unique domain id which this set of attributes references. +required
  • @param workflow Workflow name which this set of attributes references. +required
  • @param body

@return AdminWorkflowAttributesDeleteResponse

func (*AdminServiceApiService) GetActiveLaunchPlan ¶ added in v0.1.1 

func (a *AdminServiceApiService) GetActiveLaunchPlan(ctx context.Context, idProject string, idDomain string, idName string) (AdminLaunchPlan, *http.Response, error)

AdminServiceApiService Fetch the active version of a :ref:`ref_flyteidl.admin.LaunchPlan`.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param idProject Name of the project the resource belongs to.
  • @param idDomain Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.
  • @param idName User provided value for the resource. The combination of project + domain + name uniquely identifies the resource. +optional - in certain contexts - like 'List API', 'Launch plans'

@return AdminLaunchPlan

func (*AdminServiceApiService) GetDescriptionEntity ¶ added in v1.2.4 

func (a *AdminServiceApiService) GetDescriptionEntity(ctx context.Context, idResourceType string, idProject string, idDomain string, idName string, idVersion string) (AdminDescriptionEntity, *http.Response, error)

AdminServiceApiService Fetch a :ref:`ref_flyteidl.admin.DescriptionEntity` object.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param idResourceType Identifies the specific type of resource that this identifier corresponds to.
  • @param idProject Name of the project the resource belongs to.
  • @param idDomain Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.
  • @param idName User provided value for the resource.
  • @param idVersion Specific version of the resource.

@return AdminDescriptionEntity

func (*AdminServiceApiService) GetExecution ¶ 

func (a *AdminServiceApiService) GetExecution(ctx context.Context, idProject string, idDomain string, idName string) (AdminExecution, *http.Response, error)

AdminServiceApiService Fetches a :ref:`ref_flyteidl.admin.Execution`.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param idProject Name of the project the resource belongs to.
  • @param idDomain Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.
  • @param idName User or system provided value for the resource.

@return AdminExecution

func (*AdminServiceApiService) GetExecutionData ¶ 

func (a *AdminServiceApiService) GetExecutionData(ctx context.Context, idProject string, idDomain string, idName string) (AdminWorkflowExecutionGetDataResponse, *http.Response, error)

AdminServiceApiService Fetches input and output data for a :ref:`ref_flyteidl.admin.Execution`.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param idProject Name of the project the resource belongs to.
  • @param idDomain Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.
  • @param idName User or system provided value for the resource.

@return AdminWorkflowExecutionGetDataResponse

func (*AdminServiceApiService) GetExecutionMetrics ¶ added in v1.2.10 

func (a *AdminServiceApiService) GetExecutionMetrics(ctx context.Context, idProject string, idDomain string, idName string, localVarOptionals *GetExecutionMetricsOpts) (AdminWorkflowExecutionGetMetricsResponse, *http.Response, error)

func (*AdminServiceApiService) GetLaunchPlan ¶ 

func (a *AdminServiceApiService) GetLaunchPlan(ctx context.Context, idProject string, idDomain string, idName string, idVersion string, localVarOptionals *GetLaunchPlanOpts) (AdminLaunchPlan, *http.Response, error)

func (*AdminServiceApiService) GetNamedEntity ¶ added in v0.16.1 

func (a *AdminServiceApiService) GetNamedEntity(ctx context.Context, resourceType string, idProject string, idDomain string, idName string) (AdminNamedEntity, *http.Response, error)

AdminServiceApiService Returns a :ref:`ref_flyteidl.admin.NamedEntity` object.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param resourceType Resource type of the metadata to get. One of Task, Workflow or LaunchPlan. +required
  • @param idProject Name of the project the resource belongs to.
  • @param idDomain Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.
  • @param idName User provided value for the resource. The combination of project + domain + name uniquely identifies the resource. +optional - in certain contexts - like 'List API', 'Launch plans'

@return AdminNamedEntity

func (*AdminServiceApiService) GetNodeExecution ¶ 

func (a *AdminServiceApiService) GetNodeExecution(ctx context.Context, idExecutionIdProject string, idExecutionIdDomain string, idExecutionIdName string, idNodeId string) (FlyteidladminNodeExecution, *http.Response, error)

AdminServiceApiService Fetches a :ref:`ref_flyteidl.admin.NodeExecution`.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param idExecutionIdProject Name of the project the resource belongs to.
  • @param idExecutionIdDomain Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.
  • @param idExecutionIdName User or system provided value for the resource.
  • @param idNodeId

@return FlyteidladminNodeExecution

func (*AdminServiceApiService) GetNodeExecutionData ¶ 

func (a *AdminServiceApiService) GetNodeExecutionData(ctx context.Context, idExecutionIdProject string, idExecutionIdDomain string, idExecutionIdName string, idNodeId string) (AdminNodeExecutionGetDataResponse, *http.Response, error)

AdminServiceApiService Fetches input and output data for a :ref:`ref_flyteidl.admin.NodeExecution`.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param idExecutionIdProject Name of the project the resource belongs to.
  • @param idExecutionIdDomain Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.
  • @param idExecutionIdName User or system provided value for the resource.
  • @param idNodeId

@return AdminNodeExecutionGetDataResponse

func (*AdminServiceApiService) GetProjectAttributes ¶ added in v0.16.5 

func (a *AdminServiceApiService) GetProjectAttributes(ctx context.Context, project string, localVarOptionals *GetProjectAttributesOpts) (AdminProjectAttributesGetResponse, *http.Response, error)

func (*AdminServiceApiService) GetProjectDomainAttributes ¶ added in v0.16.5 

func (a *AdminServiceApiService) GetProjectDomainAttributes(ctx context.Context, project string, domain string, localVarOptionals *GetProjectDomainAttributesOpts) (AdminProjectDomainAttributesGetResponse, *http.Response, error)

func (*AdminServiceApiService) GetTask ¶ 

func (a *AdminServiceApiService) GetTask(ctx context.Context, idProject string, idDomain string, idName string, idVersion string, localVarOptionals *GetTaskOpts) (AdminTask, *http.Response, error)

func (*AdminServiceApiService) GetTaskExecution ¶ 

func (a *AdminServiceApiService) GetTaskExecution(ctx context.Context, idNodeExecutionIdExecutionIdProject string, idNodeExecutionIdExecutionIdDomain string, idNodeExecutionIdExecutionIdName string, idNodeExecutionIdNodeId string, idTaskIdProject string, idTaskIdDomain string, idTaskIdName string, idTaskIdVersion string, idRetryAttempt int64, localVarOptionals *GetTaskExecutionOpts) (FlyteidladminTaskExecution, *http.Response, error)

func (*AdminServiceApiService) GetTaskExecutionData ¶ 

func (a *AdminServiceApiService) GetTaskExecutionData(ctx context.Context, idNodeExecutionIdExecutionIdProject string, idNodeExecutionIdExecutionIdDomain string, idNodeExecutionIdExecutionIdName string, idNodeExecutionIdNodeId string, idTaskIdProject string, idTaskIdDomain string, idTaskIdName string, idTaskIdVersion string, idRetryAttempt int64, localVarOptionals *GetTaskExecutionDataOpts) (AdminTaskExecutionGetDataResponse, *http.Response, error)

func (*AdminServiceApiService) GetVersion ¶ added in v0.18.17 

func (a *AdminServiceApiService) GetVersion(ctx context.Context) (AdminGetVersionResponse, *http.Response, error)

AdminServiceApiService

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return AdminGetVersionResponse

func (*AdminServiceApiService) GetWorkflow ¶ 

func (a *AdminServiceApiService) GetWorkflow(ctx context.Context, idProject string, idDomain string, idName string, idVersion string, localVarOptionals *GetWorkflowOpts) (AdminWorkflow, *http.Response, error)

func (*AdminServiceApiService) GetWorkflowAttributes ¶ added in v0.16.5 

func (a *AdminServiceApiService) GetWorkflowAttributes(ctx context.Context, project string, domain string, workflow string, localVarOptionals *GetWorkflowAttributesOpts) (AdminWorkflowAttributesGetResponse, *http.Response, error)

func (*AdminServiceApiService) ListActiveLaunchPlans ¶ added in v0.1.1 

func (a *AdminServiceApiService) ListActiveLaunchPlans(ctx context.Context, project string, domain string, localVarOptionals *ListActiveLaunchPlansOpts) (AdminLaunchPlanList, *http.Response, error)

func (*AdminServiceApiService) ListDescriptionEntities ¶ added in v1.2.4 

func (a *AdminServiceApiService) ListDescriptionEntities(ctx context.Context, resourceType string, idProject string, idDomain string, idName string, localVarOptionals *ListDescriptionEntitiesOpts) (AdminDescriptionEntityList, *http.Response, error)

func (*AdminServiceApiService) ListDescriptionEntities2 ¶ added in v1.2.4 

func (a *AdminServiceApiService) ListDescriptionEntities2(ctx context.Context, resourceType string, idProject string, idDomain string, localVarOptionals *ListDescriptionEntities2Opts) (AdminDescriptionEntityList, *http.Response, error)

func (*AdminServiceApiService) ListExecutions ¶ 

func (a *AdminServiceApiService) ListExecutions(ctx context.Context, idProject string, idDomain string, localVarOptionals *ListExecutionsOpts) (AdminExecutionList, *http.Response, error)

func (*AdminServiceApiService) ListLaunchPlanIds ¶ 

func (a *AdminServiceApiService) ListLaunchPlanIds(ctx context.Context, project string, domain string, localVarOptionals *ListLaunchPlanIdsOpts) (AdminNamedEntityIdentifierList, *http.Response, error)

func (*AdminServiceApiService) ListLaunchPlans ¶ 

func (a *AdminServiceApiService) ListLaunchPlans(ctx context.Context, idProject string, idDomain string, idName string, localVarOptionals *ListLaunchPlansOpts) (AdminLaunchPlanList, *http.Response, error)

func (*AdminServiceApiService) ListLaunchPlans2 ¶ 

func (a *AdminServiceApiService) ListLaunchPlans2(ctx context.Context, idProject string, idDomain string, localVarOptionals *ListLaunchPlans2Opts) (AdminLaunchPlanList, *http.Response, error)

func (*AdminServiceApiService) ListMatchableAttributes ¶ added in v0.18.15 

func (a *AdminServiceApiService) ListMatchableAttributes(ctx context.Context, localVarOptionals *ListMatchableAttributesOpts) (AdminListMatchableAttributesResponse, *http.Response, error)

func (*AdminServiceApiService) ListNamedEntities ¶ added in v0.16.1 

func (a *AdminServiceApiService) ListNamedEntities(ctx context.Context, resourceType string, project string, domain string, localVarOptionals *ListNamedEntitiesOpts) (AdminNamedEntityList, *http.Response, error)

func (*AdminServiceApiService) ListNodeExecutions ¶ 

func (a *AdminServiceApiService) ListNodeExecutions(ctx context.Context, workflowExecutionIdProject string, workflowExecutionIdDomain string, workflowExecutionIdName string, localVarOptionals *ListNodeExecutionsOpts) (AdminNodeExecutionList, *http.Response, error)

func (*AdminServiceApiService) ListNodeExecutionsForTask ¶ 

func (a *AdminServiceApiService) ListNodeExecutionsForTask(ctx context.Context, taskExecutionIdNodeExecutionIdExecutionIdProject string, taskExecutionIdNodeExecutionIdExecutionIdDomain string, taskExecutionIdNodeExecutionIdExecutionIdName string, taskExecutionIdNodeExecutionIdNodeId string, taskExecutionIdTaskIdProject string, taskExecutionIdTaskIdDomain string, taskExecutionIdTaskIdName string, taskExecutionIdTaskIdVersion string, taskExecutionIdRetryAttempt int64, localVarOptionals *ListNodeExecutionsForTaskOpts) (AdminNodeExecutionList, *http.Response, error)

func (*AdminServiceApiService) ListProjects ¶ 

func (a *AdminServiceApiService) ListProjects(ctx context.Context, localVarOptionals *ListProjectsOpts) (AdminProjects, *http.Response, error)

func (*AdminServiceApiService) ListTaskExecutions ¶ 

func (a *AdminServiceApiService) ListTaskExecutions(ctx context.Context, nodeExecutionIdExecutionIdProject string, nodeExecutionIdExecutionIdDomain string, nodeExecutionIdExecutionIdName string, nodeExecutionIdNodeId string, localVarOptionals *ListTaskExecutionsOpts) (AdminTaskExecutionList, *http.Response, error)

func (*AdminServiceApiService) ListTaskIds ¶ 

func (a *AdminServiceApiService) ListTaskIds(ctx context.Context, project string, domain string, localVarOptionals *ListTaskIdsOpts) (AdminNamedEntityIdentifierList, *http.Response, error)

func (*AdminServiceApiService) ListTasks ¶ 

func (a *AdminServiceApiService) ListTasks(ctx context.Context, idProject string, idDomain string, idName string, localVarOptionals *ListTasksOpts) (AdminTaskList, *http.Response, error)

func (*AdminServiceApiService) ListTasks2 ¶ 

func (a *AdminServiceApiService) ListTasks2(ctx context.Context, idProject string, idDomain string, localVarOptionals *ListTasks2Opts) (AdminTaskList, *http.Response, error)

func (*AdminServiceApiService) ListWorkflowIds ¶ 

func (a *AdminServiceApiService) ListWorkflowIds(ctx context.Context, project string, domain string, localVarOptionals *ListWorkflowIdsOpts) (AdminNamedEntityIdentifierList, *http.Response, error)

func (*AdminServiceApiService) ListWorkflows ¶ 

func (a *AdminServiceApiService) ListWorkflows(ctx context.Context, idProject string, idDomain string, idName string, localVarOptionals *ListWorkflowsOpts) (AdminWorkflowList, *http.Response, error)

func (*AdminServiceApiService) ListWorkflows2 ¶ 

func (a *AdminServiceApiService) ListWorkflows2(ctx context.Context, idProject string, idDomain string, localVarOptionals *ListWorkflows2Opts) (AdminWorkflowList, *http.Response, error)

func (*AdminServiceApiService) RecoverExecution ¶ added in v0.19.14 

func (a *AdminServiceApiService) RecoverExecution(ctx context.Context, body AdminExecutionRecoverRequest) (AdminExecutionCreateResponse, *http.Response, error)

AdminServiceApiService Recreates a previously-run workflow execution that will only start executing from the last known failure point. In Recover mode, users cannot change any input parameters or update the version of the execution. This is extremely useful to recover from system errors and byzantine faults like - Loss of K8s cluster, bugs in platform or instability, machine failures, downstream system failures (downstream services), or simply to recover executions that failed because of retry exhaustion and should complete if tried again. See :ref:`ref_flyteidl.admin.ExecutionRecoverRequest` for more details.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return AdminExecutionCreateResponse

func (*AdminServiceApiService) RegisterProject ¶ 

func (a *AdminServiceApiService) RegisterProject(ctx context.Context, body AdminProjectRegisterRequest) (AdminProjectRegisterResponse, *http.Response, error)

AdminServiceApiService Registers a :ref:`ref_flyteidl.admin.Project` with the Flyte deployment.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return AdminProjectRegisterResponse

func (*AdminServiceApiService) RelaunchExecution ¶ 

func (a *AdminServiceApiService) RelaunchExecution(ctx context.Context, body AdminExecutionRelaunchRequest) (AdminExecutionCreateResponse, *http.Response, error)

AdminServiceApiService Triggers the creation of an identical :ref:`ref_flyteidl.admin.Execution`

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return AdminExecutionCreateResponse

func (*AdminServiceApiService) TerminateExecution ¶ 

func (a *AdminServiceApiService) TerminateExecution(ctx context.Context, idProject string, idDomain string, idName string, body AdminExecutionTerminateRequest) (AdminExecutionTerminateResponse, *http.Response, error)

AdminServiceApiService Terminates an in-progress :ref:`ref_flyteidl.admin.Execution`.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param idProject Name of the project the resource belongs to.
  • @param idDomain Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.
  • @param idName User or system provided value for the resource.
  • @param body

@return AdminExecutionTerminateResponse

func (*AdminServiceApiService) UpdateExecution ¶ added in v0.21.24 

func (a *AdminServiceApiService) UpdateExecution(ctx context.Context, idProject string, idDomain string, idName string, body AdminExecutionUpdateRequest) (AdminExecutionUpdateResponse, *http.Response, error)

AdminServiceApiService Update execution belonging to project domain :ref:`ref_flyteidl.admin.Execution`.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param idProject Name of the project the resource belongs to.
  • @param idDomain Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.
  • @param idName User or system provided value for the resource.
  • @param body

@return AdminExecutionUpdateResponse

func (*AdminServiceApiService) UpdateLaunchPlan ¶ 

func (a *AdminServiceApiService) UpdateLaunchPlan(ctx context.Context, idProject string, idDomain string, idName string, idVersion string, body AdminLaunchPlanUpdateRequest) (AdminLaunchPlanUpdateResponse, *http.Response, error)

AdminServiceApiService Updates the status of a registered :ref:`ref_flyteidl.admin.LaunchPlan`.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param idProject Name of the project the resource belongs to.
  • @param idDomain Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.
  • @param idName User provided value for the resource.
  • @param idVersion Specific version of the resource.
  • @param body

@return AdminLaunchPlanUpdateResponse

func (*AdminServiceApiService) UpdateNamedEntity ¶ added in v0.16.1 

func (a *AdminServiceApiService) UpdateNamedEntity(ctx context.Context, resourceType string, idProject string, idDomain string, idName string, body AdminNamedEntityUpdateRequest) (AdminNamedEntityUpdateResponse, *http.Response, error)

AdminServiceApiService Updates a :ref:`ref_flyteidl.admin.NamedEntity` object.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param resourceType Resource type of the metadata to update +required
  • @param idProject Name of the project the resource belongs to.
  • @param idDomain Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.
  • @param idName User provided value for the resource. The combination of project + domain + name uniquely identifies the resource. +optional - in certain contexts - like 'List API', 'Launch plans'
  • @param body

@return AdminNamedEntityUpdateResponse

func (*AdminServiceApiService) UpdateProject ¶ added in v0.18.15 

func (a *AdminServiceApiService) UpdateProject(ctx context.Context, id string, body AdminProject) (AdminProjectUpdateResponse, *http.Response, error)

AdminServiceApiService Updates an existing :ref:`ref_flyteidl.admin.Project` flyteidl.admin.Project should be passed but the domains property should be empty; it will be ignored in the handler as domains cannot be updated via this API.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id Globally unique project name.
  • @param body

@return AdminProjectUpdateResponse

func (*AdminServiceApiService) UpdateProjectAttributes ¶ added in v0.16.4 

func (a *AdminServiceApiService) UpdateProjectAttributes(ctx context.Context, attributesProject string, body AdminProjectAttributesUpdateRequest) (AdminProjectAttributesUpdateResponse, *http.Response, error)

AdminServiceApiService Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` at the project level

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param attributesProject Unique project id for which this set of attributes will be applied.
  • @param body

@return AdminProjectAttributesUpdateResponse

func (*AdminServiceApiService) UpdateProjectDomainAttributes ¶ added in v0.16.1 

func (a *AdminServiceApiService) UpdateProjectDomainAttributes(ctx context.Context, attributesProject string, attributesDomain string, body AdminProjectDomainAttributesUpdateRequest) (AdminProjectDomainAttributesUpdateResponse, *http.Response, error)

AdminServiceApiService Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project and domain.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param attributesProject Unique project id for which this set of attributes will be applied.
  • @param attributesDomain Unique domain id for which this set of attributes will be applied.
  • @param body

@return AdminProjectDomainAttributesUpdateResponse

func (*AdminServiceApiService) UpdateWorkflowAttributes ¶ added in v0.16.4 

func (a *AdminServiceApiService) UpdateWorkflowAttributes(ctx context.Context, attributesProject string, attributesDomain string, attributesWorkflow string, body AdminWorkflowAttributesUpdateRequest) (AdminWorkflowAttributesUpdateResponse, *http.Response, error)

AdminServiceApiService Creates or updates custom :ref:`ref_flyteidl.admin.MatchableAttributesConfiguration` for a project, domain and workflow.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param attributesProject Unique project id for which this set of attributes will be applied.
  • @param attributesDomain Unique domain id for which this set of attributes will be applied.
  • @param attributesWorkflow Workflow name for which this set of attributes will be applied.
  • @param body

@return AdminWorkflowAttributesUpdateResponse

type AdminSlackNotification ¶ 

type AdminSlackNotification struct {
	RecipientsEmail []string `json:"recipients_email,omitempty"`
}

Defines a slack notification specification.

type AdminSort ¶ 

type AdminSort struct {
	Key       string         `json:"key,omitempty"`
	Direction *SortDirection `json:"direction,omitempty"`
}

Specifies sort ordering in a list request.

type AdminSourceCode ¶ added in v1.2.4 

type AdminSourceCode struct {
	Link string `json:"link,omitempty"`
}

type AdminSystemMetadata ¶ added in v0.18.15 

type AdminSystemMetadata struct {
	// Which execution cluster this execution ran on.
	ExecutionCluster string `json:"execution_cluster,omitempty"`
	// Which kubernetes namespace the execution ran under.
	Namespace string `json:"namespace,omitempty"`
}

Represents system, rather than user-facing, metadata about an execution.

type AdminTask ¶ 

type AdminTask struct {
	// id represents the unique identifier of the task.
	Id *CoreIdentifier `json:"id,omitempty"`
	// closure encapsulates all the fields that maps to a compiled version of the task.
	Closure *AdminTaskClosure `json:"closure,omitempty"`
	// One-liner overview of the entity.
	ShortDescription string `json:"short_description,omitempty"`
}

Flyte workflows are composed of many ordered tasks. That is small, reusable, self-contained logical blocks arranged to process workflow inputs and produce a deterministic set of outputs. Tasks can come in many varieties tuned for specialized behavior.

type AdminTaskClosure ¶ 

type AdminTaskClosure struct {
	// Represents the compiled representation of the task from the specification provided.
	CompiledTask *CoreCompiledTask `json:"compiled_task,omitempty"`
	// Time at which the task was created.
	CreatedAt time.Time `json:"created_at,omitempty"`
}

Compute task attributes which include values derived from the TaskSpec, as well as plugin-specific data and task metadata.

type AdminTaskExecutionClosure ¶ 

type AdminTaskExecutionClosure struct {
	// Path to remote data store where output blob is stored if the execution succeeded (and produced outputs). DEPRECATED. Use GetTaskExecutionData to fetch output data instead.
	OutputUri string `json:"output_uri,omitempty"`
	// Error information for the task execution. Populated if the execution failed.
	Error_ *CoreExecutionError `json:"error,omitempty"`
	// Raw output data produced by this task execution. DEPRECATED. Use GetTaskExecutionData to fetch output data instead.
	OutputData *CoreLiteralMap `json:"output_data,omitempty"`
	// The last recorded phase for this task execution.
	Phase *CoreTaskExecutionPhase `json:"phase,omitempty"`
	// Detailed log information output by the task execution.
	Logs []CoreTaskLog `json:"logs,omitempty"`
	// Time at which the task execution began running.
	StartedAt time.Time `json:"started_at,omitempty"`
	// The amount of time the task execution spent running.
	Duration string `json:"duration,omitempty"`
	// Time at which the task execution was created.
	CreatedAt time.Time `json:"created_at,omitempty"`
	// Time at which the task execution was last updated.
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// Custom data specific to the task plugin.
	CustomInfo *ProtobufStruct `json:"custom_info,omitempty"`
	// If there is an explanation for the most recent phase transition, the reason will capture it.
	Reason string `json:"reason,omitempty"`
	// A predefined yet extensible Task type identifier.
	TaskType string `json:"task_type,omitempty"`
	// Metadata around how a task was executed.
	Metadata *FlyteidleventTaskExecutionMetadata `json:"metadata,omitempty"`
	// The event version is used to indicate versioned changes in how data is maintained using this proto message. For example, event_verison > 0 means that maps tasks logs use the TaskExecutionMetadata ExternalResourceInfo fields for each subtask rather than the TaskLog in this message.
	EventVersion int32 `json:"event_version,omitempty"`
	// A time-series of the phase transition or update explanations. This, when compared to storing a singular reason as previously done, is much more valuable in visualizing and understanding historical evaluations.
	Reasons []AdminReason `json:"reasons,omitempty"`
}

Container for task execution details and results.

type AdminTaskExecutionEventRequest ¶ 

type AdminTaskExecutionEventRequest struct {
	RequestId string `json:"request_id,omitempty"`
	// Details about the event that occurred.
	Event *EventTaskExecutionEvent `json:"event,omitempty"`
}

Request to send a notification that a task execution event has occurred.

type AdminTaskExecutionEventResponse ¶ 

type AdminTaskExecutionEventResponse struct {
}

type AdminTaskExecutionGetDataResponse ¶ 

type AdminTaskExecutionGetDataResponse struct {
	// Signed url to fetch a core.LiteralMap of task execution inputs. Deprecated: Please use full_inputs instead.
	Inputs *AdminUrlBlob `json:"inputs,omitempty"`
	// Signed url to fetch a core.LiteralMap of task execution outputs. Deprecated: Please use full_outputs instead.
	Outputs *AdminUrlBlob `json:"outputs,omitempty"`
	// Full_inputs will only be populated if they are under a configured size threshold.
	FullInputs *CoreLiteralMap `json:"full_inputs,omitempty"`
	// Full_outputs will only be populated if they are under a configured size threshold.
	FullOutputs *CoreLiteralMap `json:"full_outputs,omitempty"`
	FlyteUrls   *AdminFlyteUrLs `json:"flyte_urls,omitempty"`
}

Response structure for TaskExecutionGetDataRequest which contains inputs and outputs for a task execution.

type AdminTaskExecutionList ¶ 

type AdminTaskExecutionList struct {
	TaskExecutions []FlyteidladminTaskExecution `json:"task_executions,omitempty"`
	// In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty.
	Token string `json:"token,omitempty"`
}

type AdminTaskList ¶ 

type AdminTaskList struct {
	// A list of tasks returned based on the request.
	Tasks []AdminTask `json:"tasks,omitempty"`
	// In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty.
	Token string `json:"token,omitempty"`
}

type AdminTaskResourceAttributes ¶ added in v0.16.4 

type AdminTaskResourceAttributes struct {
	Defaults *AdminTaskResourceSpec `json:"defaults,omitempty"`
	Limits   *AdminTaskResourceSpec `json:"limits,omitempty"`
}

Defines task resource defaults and limits that will be applied at task registration.

type AdminTaskResourceSpec ¶ added in v0.16.4 

type AdminTaskResourceSpec struct {
	Cpu              string `json:"cpu,omitempty"`
	Gpu              string `json:"gpu,omitempty"`
	Memory           string `json:"memory,omitempty"`
	Storage          string `json:"storage,omitempty"`
	EphemeralStorage string `json:"ephemeral_storage,omitempty"`
}

Defines a set of overridable task resource attributes set during task registration.

type AdminTaskSpec ¶ 

type AdminTaskSpec struct {
	// Template of the task that encapsulates all the metadata of the task.
	Template *CoreTaskTemplate `json:"template,omitempty"`
	// Represents the specification for description entity.
	Description *AdminDescriptionEntity `json:"description,omitempty"`
}

Represents a structure that encapsulates the user-configured specification of the task.

type AdminUrlBlob ¶ 

type AdminUrlBlob struct {
	// Actual url value.
	Url string `json:"url,omitempty"`
	// Represents the size of the file accessible at the above url.
	Bytes string `json:"bytes,omitempty"`
}

Represents a string url and associated metadata used throughout the platform.

type AdminVersion ¶ added in v0.18.17 

type AdminVersion struct {
	Build     string `json:"Build,omitempty"`
	Version   string `json:"Version,omitempty"`
	BuildTime string `json:"BuildTime,omitempty"`
}

type AdminWorkflow ¶ 

type AdminWorkflow struct {
	// id represents the unique identifier of the workflow.
	Id *CoreIdentifier `json:"id,omitempty"`
	// closure encapsulates all the fields that maps to a compiled version of the workflow.
	Closure *AdminWorkflowClosure `json:"closure,omitempty"`
	// One-liner overview of the entity.
	ShortDescription string `json:"short_description,omitempty"`
}

Represents the workflow structure stored in the Admin A workflow is created by ordering tasks and associating outputs to inputs in order to produce a directed-acyclic execution graph.

type AdminWorkflowAttributes ¶ added in v0.16.4 

type AdminWorkflowAttributes struct {
	// Unique project id for which this set of attributes will be applied.
	Project string `json:"project,omitempty"`
	// Unique domain id for which this set of attributes will be applied.
	Domain string `json:"domain,omitempty"`
	// Workflow name for which this set of attributes will be applied.
	Workflow           string                   `json:"workflow,omitempty"`
	MatchingAttributes *AdminMatchingAttributes `json:"matching_attributes,omitempty"`
}

type AdminWorkflowAttributesDeleteRequest ¶ added in v0.16.5 

type AdminWorkflowAttributesDeleteRequest struct {
	Project      string                  `json:"project,omitempty"`
	Domain       string                  `json:"domain,omitempty"`
	Workflow     string                  `json:"workflow,omitempty"`
	ResourceType *AdminMatchableResource `json:"resource_type,omitempty"`
}

type AdminWorkflowAttributesDeleteResponse ¶ added in v0.16.5 

type AdminWorkflowAttributesDeleteResponse struct {
}

Purposefully empty, may be populated in the future.

type AdminWorkflowAttributesGetResponse ¶ added in v0.16.5 

type AdminWorkflowAttributesGetResponse struct {
	Attributes *AdminWorkflowAttributes `json:"attributes,omitempty"`
}

Response to get an individual workflow attribute override.

type AdminWorkflowAttributesUpdateRequest ¶ added in v0.16.4 

type AdminWorkflowAttributesUpdateRequest struct {
	Attributes *AdminWorkflowAttributes `json:"attributes,omitempty"`
}

type AdminWorkflowAttributesUpdateResponse ¶ added in v0.16.4 

type AdminWorkflowAttributesUpdateResponse struct {
}

Purposefully empty, may be populated in the future.

type AdminWorkflowClosure ¶ 

type AdminWorkflowClosure struct {
	// Represents the compiled representation of the workflow from the specification provided.
	CompiledWorkflow *CoreCompiledWorkflowClosure `json:"compiled_workflow,omitempty"`
	// Time at which the workflow was created.
	CreatedAt time.Time `json:"created_at,omitempty"`
}

A container holding the compiled workflow produced from the WorkflowSpec and additional metadata.

type AdminWorkflowCreateRequest ¶ 

type AdminWorkflowCreateRequest struct {
	Id   *CoreIdentifier    `json:"id,omitempty"`
	Spec *AdminWorkflowSpec `json:"spec,omitempty"`
}

type AdminWorkflowCreateResponse ¶ 

type AdminWorkflowCreateResponse struct {
}

type AdminWorkflowExecutionConfig ¶ added in v0.18.54 

type AdminWorkflowExecutionConfig struct {
	// Can be used to control the number of parallel nodes to run within the workflow. This is useful to achieve fairness.
	MaxParallelism int32 `json:"max_parallelism,omitempty"`
	// Indicates security context permissions for executions triggered with this matchable attribute.
	SecurityContext *CoreSecurityContext `json:"security_context,omitempty"`
	// Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.).
	RawOutputDataConfig *AdminRawOutputDataConfig `json:"raw_output_data_config,omitempty"`
	// Custom labels to be applied to a triggered execution resource.
	Labels *AdminLabels `json:"labels,omitempty"`
	// Custom annotations to be applied to a triggered execution resource.
	Annotations *AdminAnnotations `json:"annotations,omitempty"`
	// Allows for the interruptible flag of a workflow to be overwritten for a single execution. Omitting this field uses the workflow's value as a default. As we need to distinguish between the field not being provided and its default value false, we have to use a wrapper around the bool field.
	Interruptible bool `json:"interruptible,omitempty"`
	// Allows for all cached values of a workflow and its tasks to be overwritten for a single execution. If enabled, all calculations are performed even if cached results would be available, overwriting the stored data once execution finishes successfully.
	OverwriteCache bool `json:"overwrite_cache,omitempty"`
	// Environment variables to be set for the execution.
	Envs *AdminEnvs `json:"envs,omitempty"`
}

Adds defaults for customizable workflow-execution specifications and overrides.

type AdminWorkflowExecutionEventRequest ¶ 

type AdminWorkflowExecutionEventRequest struct {
	RequestId string `json:"request_id,omitempty"`
	// Details about the event that occurred.
	Event *EventWorkflowExecutionEvent `json:"event,omitempty"`
}

Request to send a notification that a workflow execution event has occurred.

type AdminWorkflowExecutionEventResponse ¶ 

type AdminWorkflowExecutionEventResponse struct {
}

type AdminWorkflowExecutionGetDataResponse ¶ 

type AdminWorkflowExecutionGetDataResponse struct {
	// Signed url to fetch a core.LiteralMap of execution outputs. Deprecated: Please use full_outputs instead.
	Outputs *AdminUrlBlob `json:"outputs,omitempty"`
	// Signed url to fetch a core.LiteralMap of execution inputs. Deprecated: Please use full_inputs instead.
	Inputs *AdminUrlBlob `json:"inputs,omitempty"`
	// Full_inputs will only be populated if they are under a configured size threshold.
	FullInputs *CoreLiteralMap `json:"full_inputs,omitempty"`
	// Full_outputs will only be populated if they are under a configured size threshold.
	FullOutputs *CoreLiteralMap `json:"full_outputs,omitempty"`
}

Response structure for WorkflowExecutionGetDataRequest which contains inputs and outputs for an execution.

type AdminWorkflowExecutionGetMetricsResponse ¶ added in v1.2.10 

type AdminWorkflowExecutionGetMetricsResponse struct {
	// Span defines the top-level breakdown of the workflows execution. More precise information is nested in a hierarchical structure using Flyte entity references.
	Span *CoreSpan `json:"span,omitempty"`
}

WorkflowExecutionGetMetricsResponse represents the response containing metrics for the specified workflow execution.

type AdminWorkflowList ¶ 

type AdminWorkflowList struct {
	// A list of workflows returned based on the request.
	Workflows []AdminWorkflow `json:"workflows,omitempty"`
	// In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty.
	Token string `json:"token,omitempty"`
}

type AdminWorkflowSpec ¶ 

type AdminWorkflowSpec struct {
	// Template of the task that encapsulates all the metadata of the workflow.
	Template *CoreWorkflowTemplate `json:"template,omitempty"`
	// Workflows that are embedded into other workflows need to be passed alongside the parent workflow to the propeller compiler (since the compiler doesn't have any knowledge of other workflows - ie, it doesn't reach out to Admin to see other registered workflows).  In fact, subworkflows do not even need to be registered.
	SubWorkflows []CoreWorkflowTemplate `json:"sub_workflows,omitempty"`
	// Represents the specification for description entity.
	Description *AdminDescriptionEntity `json:"description,omitempty"`
}

Represents a structure that encapsulates the specification of the workflow.

type BasicAuth ¶ 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BlobTypeBlobDimensionality ¶ 

type BlobTypeBlobDimensionality string
const (
	BlobTypeBlobDimensionalitySINGLE    BlobTypeBlobDimensionality = "SINGLE"
	BlobTypeBlobDimensionalityMULTIPART BlobTypeBlobDimensionality = "MULTIPART"
)

List of BlobTypeBlobDimensionality

type CatalogReservationStatus ¶ added in v0.21.11 

type CatalogReservationStatus string

CatalogReservationStatus : Indicates the status of a catalog reservation operation. - RESERVATION_DISABLED: Used to indicate that reservations are disabled - RESERVATION_ACQUIRED: Used to indicate that a reservation was successfully acquired or extended - RESERVATION_EXISTS: Used to indicate that an active reservation currently exists - RESERVATION_RELEASED: Used to indicate that the reservation has been successfully released - RESERVATION_FAILURE: Used to indicate that a reservation operation resulted in failure 

const (
	CatalogReservationStatusDISABLED CatalogReservationStatus = "RESERVATION_DISABLED"
	CatalogReservationStatusACQUIRED CatalogReservationStatus = "RESERVATION_ACQUIRED"
	CatalogReservationStatusEXISTS   CatalogReservationStatus = "RESERVATION_EXISTS"
	CatalogReservationStatusRELEASED CatalogReservationStatus = "RESERVATION_RELEASED"
	CatalogReservationStatusFAILURE  CatalogReservationStatus = "RESERVATION_FAILURE"
)

List of CatalogReservationStatus

type ComparisonExpressionOperator ¶ 

type ComparisonExpressionOperator string

ComparisonExpressionOperator : - GT: Greater Than - LT: Less Than 

const (
	ComparisonExpressionOperatorEQ  ComparisonExpressionOperator = "EQ"
	ComparisonExpressionOperatorNEQ ComparisonExpressionOperator = "NEQ"
	ComparisonExpressionOperatorGT  ComparisonExpressionOperator = "GT"
	ComparisonExpressionOperatorGTE ComparisonExpressionOperator = "GTE"
	ComparisonExpressionOperatorLT  ComparisonExpressionOperator = "LT"
	ComparisonExpressionOperatorLTE ComparisonExpressionOperator = "LTE"
)

List of ComparisonExpressionOperator

type Configuration ¶ 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration ¶ 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶ 

func (c *Configuration) AddDefaultHeader(key string, value string)

type ConjunctionExpressionLogicalOperator ¶ 

type ConjunctionExpressionLogicalOperator string

ConjunctionExpressionLogicalOperator : - AND: Conjunction 

const (
	ConjunctionExpressionLogicalOperatorAND ConjunctionExpressionLogicalOperator = "AND"
	ConjunctionExpressionLogicalOperatorOR  ConjunctionExpressionLogicalOperator = "OR"
)

List of ConjunctionExpressionLogicalOperator

type ConnectionSetIdList ¶ 

type ConnectionSetIdList struct {
	Ids []string `json:"ids,omitempty"`
}

type ContainerArchitecture ¶ added in v0.21.6 

type ContainerArchitecture string

ContainerArchitecture : Architecture-type the container image supports. 

const (
	ContainerArchitectureUNKNOWN ContainerArchitecture = "UNKNOWN"
	ContainerArchitectureAMD64   ContainerArchitecture = "AMD64"
	ContainerArchitectureARM64   ContainerArchitecture = "ARM64"
	ContainerArchitectureARM_V6  ContainerArchitecture = "ARM_V6"
	ContainerArchitectureARM_V7  ContainerArchitecture = "ARM_V7"
)

List of ContainerArchitecture

type CoreAlias ¶ 

type CoreAlias struct {
	// Must match one of the output variable names on a node.
	Var_ string `json:"var,omitempty"`
	// A workflow-level unique alias that downstream nodes can refer to in their input.
	Alias string `json:"alias,omitempty"`
}

Links a variable to an alias.

type CoreApproveCondition ¶ added in v1.2.1 

type CoreApproveCondition struct {
	// A unique identifier for the requested boolean signal.
	SignalId string `json:"signal_id,omitempty"`
}

ApproveCondition represents a dependency on an external approval. During execution, this will manifest as a boolean signal with the provided signal_id.

type CoreArrayNode ¶ added in v1.5.12 

type CoreArrayNode struct {
	// node is the sub-node that will be executed for each element in the array.
	Node *CoreNode `json:"node,omitempty"`
	// parallelism defines the minimum number of instances to bring up concurrently at any given point. Note that this is an optimistic restriction and that, due to network partitioning or other failures, the actual number of currently running instances might be more. This has to be a positive number if assigned. Default value is size.
	Parallelism int64 `json:"parallelism,omitempty"`
	// min_successes is an absolute number of the minimum number of successful completions of sub-nodes. As soon as this criteria is met, the ArrayNode will be marked as successful and outputs will be computed. This has to be a non-negative number if assigned. Default value is size (if specified).
	MinSuccesses int64 `json:"min_successes,omitempty"`
	// If the array job size is not known beforehand, the min_success_ratio can instead be used to determine when an ArrayNode can be marked successful.
	MinSuccessRatio float32 `json:"min_success_ratio,omitempty"`
}

ArrayNode is a Flyte node type that simplifies the execution of a sub-node over a list of input values. An ArrayNode can be executed with configurable parallelism (separate from the parent workflow) and can be configured to succeed when a certain number of sub-nodes succeed.

type CoreBinary ¶ 

type CoreBinary struct {
	Value string `json:"value,omitempty"`
	Tag   string `json:"tag,omitempty"`
}

A simple byte array with a tag to help different parts of the system communicate about what is in the byte array. It's strongly advisable that consumers of this type define a unique tag and validate the tag before parsing the data.

type CoreBinding ¶ 

type CoreBinding struct {
	// Variable name must match an input/output variable of the node.
	Var_ string `json:"var,omitempty"`
	// Data to use to bind this variable.
	Binding *CoreBindingData `json:"binding,omitempty"`
}

An input/output binding of a variable to either static value or a node output.

type CoreBindingData ¶ 

type CoreBindingData struct {
	// A simple scalar value.
	Scalar *CoreScalar `json:"scalar,omitempty"`
	// A collection of binding data. This allows nesting of binding data to any number of levels.
	Collection *CoreBindingDataCollection `json:"collection,omitempty"`
	// References an output promised by another node.
	Promise *CoreOutputReference `json:"promise,omitempty"`
	// A map of bindings. The key is always a string.
	Map_  *CoreBindingDataMap `json:"map,omitempty"`
	Union *CoreUnionInfo      `json:"union,omitempty"`
}

Specifies either a simple value or a reference to another output.

type CoreBindingDataCollection ¶ 

type CoreBindingDataCollection struct {
	Bindings []CoreBindingData `json:"bindings,omitempty"`
}

A collection of BindingData items.

type CoreBindingDataMap ¶ 

type CoreBindingDataMap struct {
	Bindings map[string]CoreBindingData `json:"bindings,omitempty"`
}

A map of BindingData items.

type CoreBlob ¶ 

type CoreBlob struct {
	Metadata *CoreBlobMetadata `json:"metadata,omitempty"`
	Uri      string            `json:"uri,omitempty"`
}

Refers to an offloaded set of files. It encapsulates the type of the store and a unique uri for where the data is. There are no restrictions on how the uri is formatted since it will depend on how to interact with the store.

type CoreBlobMetadata ¶ 

type CoreBlobMetadata struct {
	Type_ *CoreBlobType `json:"type,omitempty"`
}

type CoreBlobType ¶ 

type CoreBlobType struct {
	Format         string                      `json:"format,omitempty"`
	Dimensionality *BlobTypeBlobDimensionality `json:"dimensionality,omitempty"`
}

type CoreBooleanExpression ¶ 

type CoreBooleanExpression struct {
	Conjunction *CoreConjunctionExpression `json:"conjunction,omitempty"`
	Comparison  *CoreComparisonExpression  `json:"comparison,omitempty"`
}

Defines a boolean expression tree. It can be a simple or a conjunction expression. Multiple expressions can be combined using a conjunction or a disjunction to result in a final boolean result.

type CoreBranchNode ¶ 

type CoreBranchNode struct {
	IfElse *CoreIfElseBlock `json:"if_else,omitempty"`
}

BranchNode is a special node that alter the flow of the workflow graph. It allows the control flow to branch at runtime based on a series of conditions that get evaluated on various parameters (e.g. inputs, primitives).

type CoreCatalogArtifactTag ¶ added in v0.18.15 

type CoreCatalogArtifactTag struct {
	ArtifactId string `json:"artifact_id,omitempty"`
	Name       string `json:"name,omitempty"`
}

type CoreCatalogCacheStatus ¶ added in v0.18.15 

type CoreCatalogCacheStatus string

CoreCatalogCacheStatus : - CACHE_DISABLED: Used to indicate that caching was disabled - CACHE_MISS: Used to indicate that the cache lookup resulted in no matches - CACHE_HIT: used to indicate that the associated artifact was a result of a previous execution - CACHE_POPULATED: used to indicate that the resultant artifact was added to the cache - CACHE_LOOKUP_FAILURE: Used to indicate that cache lookup failed because of an error - CACHE_PUT_FAILURE: Used to indicate that cache lookup failed because of an error - CACHE_SKIPPED: Used to indicate the cache lookup was skipped 

const (
	CoreCatalogCacheStatusDISABLED       CoreCatalogCacheStatus = "CACHE_DISABLED"
	CoreCatalogCacheStatusMISS           CoreCatalogCacheStatus = "CACHE_MISS"
	CoreCatalogCacheStatusHIT            CoreCatalogCacheStatus = "CACHE_HIT"
	CoreCatalogCacheStatusPOPULATED      CoreCatalogCacheStatus = "CACHE_POPULATED"
	CoreCatalogCacheStatusLOOKUP_FAILURE CoreCatalogCacheStatus = "CACHE_LOOKUP_FAILURE"
	CoreCatalogCacheStatusPUT_FAILURE    CoreCatalogCacheStatus = "CACHE_PUT_FAILURE"
	CoreCatalogCacheStatusSKIPPED        CoreCatalogCacheStatus = "CACHE_SKIPPED"
)

List of coreCatalogCacheStatus

type CoreCatalogMetadata ¶ added in v0.18.15 

type CoreCatalogMetadata struct {
	DatasetId           *CoreIdentifier              `json:"dataset_id,omitempty"`
	ArtifactTag         *CoreCatalogArtifactTag      `json:"artifact_tag,omitempty"`
	SourceTaskExecution *CoreTaskExecutionIdentifier `json:"source_task_execution,omitempty"`
}

type CoreComparisonExpression ¶ 

type CoreComparisonExpression struct {
	Operator   *ComparisonExpressionOperator `json:"operator,omitempty"`
	LeftValue  *CoreOperand                  `json:"left_value,omitempty"`
	RightValue *CoreOperand                  `json:"right_value,omitempty"`
}

Defines a 2-level tree where the root is a comparison operator and Operands are primitives or known variables. Each expression results in a boolean result.

type CoreCompiledTask ¶ 

type CoreCompiledTask struct {
	Template *CoreTaskTemplate `json:"template,omitempty"`
}

type CoreCompiledWorkflow ¶ 

type CoreCompiledWorkflow struct {
	Template *CoreWorkflowTemplate `json:"template,omitempty"`
	// For internal use only! This field is used by the system and must not be filled in. Any values set will be ignored.
	Connections *CoreConnectionSet `json:"connections,omitempty"`
}

type CoreCompiledWorkflowClosure ¶ 

type CoreCompiledWorkflowClosure struct {
	Primary      *CoreCompiledWorkflow  `json:"primary,omitempty"`
	SubWorkflows []CoreCompiledWorkflow `json:"sub_workflows,omitempty"`
	Tasks        []CoreCompiledTask     `json:"tasks,omitempty"`
}

A Compiled Workflow Closure contains all the information required to start a new execution, or to visualize a workflow and its details. The CompiledWorkflowClosure should always contain a primary workflow, that is the main workflow that will being the execution. All subworkflows are denormalized. WorkflowNodes refer to the workflow identifiers of compiled subworkflows.

type CoreConjunctionExpression ¶ 

type CoreConjunctionExpression struct {
	Operator        *ConjunctionExpressionLogicalOperator `json:"operator,omitempty"`
	LeftExpression  *CoreBooleanExpression                `json:"left_expression,omitempty"`
	RightExpression *CoreBooleanExpression                `json:"right_expression,omitempty"`
}

Defines a conjunction expression of two boolean expressions.

type CoreConnectionSet ¶ 

type CoreConnectionSet struct {
	Downstream map[string]ConnectionSetIdList `json:"downstream,omitempty"`
	Upstream   map[string]ConnectionSetIdList `json:"upstream,omitempty"`
}

type CoreContainer ¶ 

type CoreContainer struct {
	Image string `json:"image,omitempty"`
	// Command to be executed, if not provided, the default entrypoint in the container image will be used.
	Command []string `json:"command,omitempty"`
	// These will default to Flyte given paths. If provided, the system will not append known paths. If the task still needs flyte's inputs and outputs path, add $(FLYTE_INPUT_FILE), $(FLYTE_OUTPUT_FILE) wherever makes sense and the system will populate these before executing the container.
	Args []string `json:"args,omitempty"`
	// Container resources requirement as specified by the container engine.
	Resources *CoreResources `json:"resources,omitempty"`
	// Environment variables will be set as the container is starting up.
	Env []CoreKeyValuePair `json:"env,omitempty"`
	// Allows extra configs to be available for the container. TODO: elaborate on how configs will become available. Deprecated, please use TaskTemplate.config instead.
	Config       []CoreKeyValuePair     `json:"config,omitempty"`
	Ports        []CoreContainerPort    `json:"ports,omitempty"`
	DataConfig   *CoreDataLoadingConfig `json:"data_config,omitempty"`
	Architecture *ContainerArchitecture `json:"architecture,omitempty"`
}

type CoreContainerPort ¶ 

type CoreContainerPort struct {
	// Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536.
	ContainerPort int64 `json:"container_port,omitempty"`
}

Defines port properties for a container.

type CoreDataLoadingConfig ¶ added in v0.18.15 

type CoreDataLoadingConfig struct {
	Enabled    bool                               `json:"enabled,omitempty"`
	InputPath  string                             `json:"input_path,omitempty"`
	OutputPath string                             `json:"output_path,omitempty"`
	Format     *DataLoadingConfigLiteralMapFormat `json:"format,omitempty"`
	IoStrategy *CoreIoStrategy                    `json:"io_strategy,omitempty"`
}

This configuration allows executing raw containers in Flyte using the Flyte CoPilot system. Flyte CoPilot, eliminates the needs of flytekit or sdk inside the container. Any inputs required by the users container are side-loaded in the input_path Any outputs generated by the user container - within output_path are automatically uploaded.

type CoreEnumType ¶ added in v0.19.0 

type CoreEnumType struct {
	// Predefined set of enum values.
	Values []string `json:"values,omitempty"`
}

Enables declaring enum types, with predefined string values For len(values) > 0, the first value in the ordered list is regarded as the default value. If you wish To provide no defaults, make the first value as undefined.

type CoreError ¶ 

type CoreError struct {
	// The node id that threw the error.
	FailedNodeId string `json:"failed_node_id,omitempty"`
	// Error message thrown.
	Message string `json:"message,omitempty"`
}

Represents an error thrown from a node.

type CoreExecutionError ¶ 

type CoreExecutionError struct {
	Code string `json:"code,omitempty"`
	// Detailed description of the error - including stack trace.
	Message  string                   `json:"message,omitempty"`
	ErrorUri string                   `json:"error_uri,omitempty"`
	Kind     *ExecutionErrorErrorKind `json:"kind,omitempty"`
}

Represents the error message from the execution.

type CoreGateNode ¶ added in v1.2.1 

type CoreGateNode struct {
	// ApproveCondition represents a dependency on an external approval provided by a boolean signal.
	Approve *CoreApproveCondition `json:"approve,omitempty"`
	// SignalCondition represents a dependency on an signal.
	Signal *CoreSignalCondition `json:"signal,omitempty"`
	// SleepCondition represents a dependency on waiting for the specified duration.
	Sleep *CoreSleepCondition `json:"sleep,omitempty"`
}

GateNode refers to the condition that is required for the gate to successfully complete.

type CoreIdentifier ¶ 

type CoreIdentifier struct {
	// Identifies the specific type of resource that this identifier corresponds to.
	ResourceType *CoreResourceType `json:"resource_type,omitempty"`
	// Name of the project the resource belongs to.
	Project string `json:"project,omitempty"`
	// Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.
	Domain string `json:"domain,omitempty"`
	// User provided value for the resource.
	Name string `json:"name,omitempty"`
	// Specific version of the resource.
	Version string `json:"version,omitempty"`
}

Encapsulation of fields that uniquely identifies a Flyte resource.

type CoreIdentity ¶ added in v0.18.16 

type CoreIdentity struct {
	// iam_role references the fully qualified name of Identity & Access Management role to impersonate.
	IamRole string `json:"iam_role,omitempty"`
	// k8s_service_account references a kubernetes service account to impersonate.
	K8sServiceAccount string `json:"k8s_service_account,omitempty"`
	// oauth2_client references an oauth2 client. Backend plugins can use this information to impersonate the client when making external calls.
	Oauth2Client      *CoreOAuth2Client `json:"oauth2_client,omitempty"`
	ExecutionIdentity string            `json:"execution_identity,omitempty"`
}

Identity encapsulates the various security identities a task can run as. It's up to the underlying plugin to pick the right identity for the execution environment.

type CoreIfBlock ¶ 

type CoreIfBlock struct {
	Condition *CoreBooleanExpression `json:"condition,omitempty"`
	ThenNode  *CoreNode              `json:"then_node,omitempty"`
}

Defines a condition and the execution unit that should be executed if the condition is satisfied.

type CoreIfElseBlock ¶ 

type CoreIfElseBlock struct {
	// +required. First condition to evaluate.
	Case_ *CoreIfBlock `json:"case,omitempty"`
	// +optional. Additional branches to evaluate.
	Other []CoreIfBlock `json:"other,omitempty"`
	// The node to execute in case none of the branches were taken.
	ElseNode *CoreNode `json:"else_node,omitempty"`
	// An error to throw in case none of the branches were taken.
	Error_ *CoreError `json:"error,omitempty"`
}

Defines a series of if/else blocks. The first branch whose condition evaluates to true is the one to execute. If no conditions were satisfied, the else_node or the error will execute.

type CoreIoStrategy ¶ added in v0.18.15 

type CoreIoStrategy struct {
	DownloadMode *IoStrategyDownloadMode `json:"download_mode,omitempty"`
	UploadMode   *IoStrategyUploadMode   `json:"upload_mode,omitempty"`
}

type CoreK8sObjectMetadata ¶ added in v0.18.48 

type CoreK8sObjectMetadata struct {
	// Optional labels to add to the pod definition.
	Labels map[string]string `json:"labels,omitempty"`
	// Optional annotations to add to the pod definition.
	Annotations map[string]string `json:"annotations,omitempty"`
}

Metadata for building a kubernetes object when a task is executed.

type CoreK8sPod ¶ added in v0.18.48 

type CoreK8sPod struct {
	// Contains additional metadata for building a kubernetes pod.
	Metadata   *CoreK8sObjectMetadata `json:"metadata,omitempty"`
	PodSpec    *ProtobufStruct        `json:"pod_spec,omitempty"`
	DataConfig *CoreDataLoadingConfig `json:"data_config,omitempty"`
}

Defines a pod spec and additional pod metadata that is created when a task is executed.

type CoreKeyValuePair ¶ 

type CoreKeyValuePair struct {
	// required.
	Key string `json:"key,omitempty"`
	// +optional.
	Value string `json:"value,omitempty"`
}

A generic key value pair.

type CoreLiteral ¶ 

type CoreLiteral struct {
	// A simple value.
	Scalar *CoreScalar `json:"scalar,omitempty"`
	// A collection of literals to allow nesting.
	Collection *CoreLiteralCollection `json:"collection,omitempty"`
	// A map of strings to literals.
	Map_ *CoreLiteralMap `json:"map,omitempty"`
	Hash string          `json:"hash,omitempty"`
}

A simple value. This supports any level of nesting (e.g. array of array of array of Blobs) as well as simple primitives.

type CoreLiteralCollection ¶ 

type CoreLiteralCollection struct {
	Literals []CoreLiteral `json:"literals,omitempty"`
}

A collection of literals. This is a workaround since oneofs in proto messages cannot contain a repeated field.

type CoreLiteralMap ¶ 

type CoreLiteralMap struct {
	Literals map[string]CoreLiteral `json:"literals,omitempty"`
}

A map of literals. This is a workaround since oneofs in proto messages cannot contain a repeated field.

type CoreLiteralType ¶ 

type CoreLiteralType struct {
	// A simple type that can be compared one-to-one with another.
	Simple *CoreSimpleType `json:"simple,omitempty"`
	// A complex type that requires matching of inner fields.
	Schema *CoreSchemaType `json:"schema,omitempty"`
	// Defines the type of the value of a collection. Only homogeneous collections are allowed.
	CollectionType *CoreLiteralType `json:"collection_type,omitempty"`
	// Defines the type of the value of a map type. The type of the key is always a string.
	MapValueType *CoreLiteralType `json:"map_value_type,omitempty"`
	// A blob might have specialized implementation details depending on associated metadata.
	Blob *CoreBlobType `json:"blob,omitempty"`
	// Defines an enum with pre-defined string values.
	EnumType              *CoreEnumType              `json:"enum_type,omitempty"`
	StructuredDatasetType *CoreStructuredDatasetType `json:"structured_dataset_type,omitempty"`
	// Defines an union type with pre-defined LiteralTypes.
	UnionType *CoreUnionType `json:"union_type,omitempty"`
	// This field contains type metadata that is descriptive of the type, but is NOT considered in type-checking.  This might be used by consumers to identify special behavior or display extended information for the type.
	Metadata *ProtobufStruct `json:"metadata,omitempty"`
	// This field contains arbitrary data that might have special semantic meaning for the client but does not effect internal flyte behavior.
	Annotation *CoreTypeAnnotation `json:"annotation,omitempty"`
	// Hints to improve type matching.
	Structure *CoreTypeStructure `json:"structure,omitempty"`
}

Defines a strong type to allow type checking between interfaces.

type CoreNode ¶ 

type CoreNode struct {
	// A workflow-level unique identifier that identifies this node in the workflow. 'inputs' and 'outputs' are reserved node ids that cannot be used by other nodes.
	Id string `json:"id,omitempty"`
	// Extra metadata about the node.
	Metadata *CoreNodeMetadata `json:"metadata,omitempty"`
	// Specifies how to bind the underlying interface's inputs. All required inputs specified in the underlying interface must be fulfilled.
	Inputs []CoreBinding `json:"inputs,omitempty"`
	// +optional Specifies execution dependency for this node ensuring it will only get scheduled to run after all its upstream nodes have completed. This node will have an implicit dependency on any node that appears in inputs field.
	UpstreamNodeIds []string `json:"upstream_node_ids,omitempty"`
	// +optional. A node can define aliases for a subset of its outputs. This is particularly useful if different nodes need to conform to the same interface (e.g. all branches in a branch node). Downstream nodes must refer to this nodes outputs using the alias if one's specified.
	OutputAliases []CoreAlias `json:"output_aliases,omitempty"`
	// Information about the Task to execute in this node.
	TaskNode *CoreTaskNode `json:"task_node,omitempty"`
	// Information about the Workflow to execute in this mode.
	WorkflowNode *CoreWorkflowNode `json:"workflow_node,omitempty"`
	// Information about the branch node to evaluate in this node.
	BranchNode *CoreBranchNode `json:"branch_node,omitempty"`
	// Information about the condition to evaluate in this node.
	GateNode *CoreGateNode `json:"gate_node,omitempty"`
	// Information about the sub-node executions for each value in the list of this nodes inputs values.
	ArrayNode *CoreArrayNode `json:"array_node,omitempty"`
}

A Workflow graph Node. One unit of execution in the graph. Each node can be linked to a Task, a Workflow or a branch node.

type CoreNodeExecutionIdentifier ¶ 

type CoreNodeExecutionIdentifier struct {
	NodeId      string                           `json:"node_id,omitempty"`
	ExecutionId *CoreWorkflowExecutionIdentifier `json:"execution_id,omitempty"`
}

Encapsulation of fields that identify a Flyte node execution entity.

type CoreNodeExecutionPhase ¶ 

type CoreNodeExecutionPhase string
const (
	CoreNodeExecutionPhaseUNDEFINED       CoreNodeExecutionPhase = "UNDEFINED"
	CoreNodeExecutionPhaseQUEUED          CoreNodeExecutionPhase = "QUEUED"
	CoreNodeExecutionPhaseRUNNING         CoreNodeExecutionPhase = "RUNNING"
	CoreNodeExecutionPhaseSUCCEEDED       CoreNodeExecutionPhase = "SUCCEEDED"
	CoreNodeExecutionPhaseFAILING         CoreNodeExecutionPhase = "FAILING"
	CoreNodeExecutionPhaseFAILED          CoreNodeExecutionPhase = "FAILED"
	CoreNodeExecutionPhaseABORTED         CoreNodeExecutionPhase = "ABORTED"
	CoreNodeExecutionPhaseSKIPPED         CoreNodeExecutionPhase = "SKIPPED"
	CoreNodeExecutionPhaseTIMED_OUT       CoreNodeExecutionPhase = "TIMED_OUT"
	CoreNodeExecutionPhaseDYNAMIC_RUNNING CoreNodeExecutionPhase = "DYNAMIC_RUNNING"
	CoreNodeExecutionPhaseRECOVERED       CoreNodeExecutionPhase = "RECOVERED"
)

List of coreNodeExecutionPhase

type CoreNodeMetadata ¶ 

type CoreNodeMetadata struct {
	Name string `json:"name,omitempty"`
	// The overall timeout of a task.
	Timeout string `json:"timeout,omitempty"`
	// Number of retries per task.
	Retries       *CoreRetryStrategy `json:"retries,omitempty"`
	Interruptible bool               `json:"interruptible,omitempty"`
}

Defines extra information about the Node.

type CoreOAuth2Client ¶ added in v0.18.16 

type CoreOAuth2Client struct {
	ClientId     string      `json:"client_id,omitempty"`
	ClientSecret *CoreSecret `json:"client_secret,omitempty"`
}

OAuth2Client encapsulates OAuth2 Client Credentials to be used when making calls on behalf of that task.

type CoreOAuth2TokenRequest ¶ added in v0.18.16 

type CoreOAuth2TokenRequest struct {
	Name                 string                      `json:"name,omitempty"`
	Type_                *CoreOAuth2TokenRequestType `json:"type,omitempty"`
	Client               *CoreOAuth2Client           `json:"client,omitempty"`
	IdpDiscoveryEndpoint string                      `json:"idp_discovery_endpoint,omitempty"`
	TokenEndpoint        string                      `json:"token_endpoint,omitempty"`
}

OAuth2TokenRequest encapsulates information needed to request an OAuth2 token. FLYTE_TOKENS_ENV_PREFIX will be passed to indicate the prefix of the environment variables that will be present if tokens are passed through environment variables. FLYTE_TOKENS_PATH_PREFIX will be passed to indicate the prefix of the path where secrets will be mounted if tokens are passed through file mounts.

type CoreOAuth2TokenRequestType ¶ added in v0.18.16 

type CoreOAuth2TokenRequestType string

CoreOAuth2TokenRequestType : Type of the token requested. - CLIENT_CREDENTIALS: CLIENT_CREDENTIALS indicates a 2-legged OAuth token requested using client credentials. 

const (
	CoreOAuth2TokenRequestTypeCLIENT_CREDENTIALS CoreOAuth2TokenRequestType = "CLIENT_CREDENTIALS"
)

List of coreOAuth2TokenRequestType

type CoreOperand ¶ 

type CoreOperand struct {
	Primitive *CorePrimitive `json:"primitive,omitempty"`
	Var_      string         `json:"var,omitempty"`
	Scalar    *CoreScalar    `json:"scalar,omitempty"`
}

Defines an operand to a comparison expression.

type CoreOutputReference ¶ 

type CoreOutputReference struct {
	// Node id must exist at the graph layer.
	NodeId string `json:"node_id,omitempty"`
	// Variable name must refer to an output variable for the node.
	Var_     string                 `json:"var,omitempty"`
	AttrPath []CorePromiseAttribute `json:"attr_path,omitempty"`
}

A reference to an output produced by a node. The type can be retrieved -and validated- from the underlying interface of the node.

type CoreParameter ¶ 

type CoreParameter struct {
	// +required Variable. Defines the type of the variable backing this parameter.
	Var_ *CoreVariable `json:"var,omitempty"`
	// Defines a default value that has to match the variable type defined.
	Default_ *CoreLiteral `json:"default,omitempty"`
	// +optional, is this value required to be filled.
	Required bool `json:"required,omitempty"`
}

A parameter is used as input to a launch plan and has the special ability to have a default value or mark itself as required.

type CoreParameterMap ¶ 

type CoreParameterMap struct {
	// Defines a map of parameter names to parameters.
	Parameters map[string]CoreParameter `json:"parameters,omitempty"`
}

A map of Parameters.

type CorePrimitive ¶ 

type CorePrimitive struct {
	Integer     string    `json:"integer,omitempty"`
	FloatValue  float64   `json:"float_value,omitempty"`
	StringValue string    `json:"string_value,omitempty"`
	Boolean     bool      `json:"boolean,omitempty"`
	Datetime    time.Time `json:"datetime,omitempty"`
	Duration    string    `json:"duration,omitempty"`
}

type CorePromiseAttribute ¶ added in v1.5.19 

type CorePromiseAttribute struct {
	StringValue string `json:"string_value,omitempty"`
	IntValue    int32  `json:"int_value,omitempty"`
}

type CoreQualityOfService ¶ added in v0.18.15 

type CoreQualityOfService struct {
	Tier *QualityOfServiceTier     `json:"tier,omitempty"`
	Spec *CoreQualityOfServiceSpec `json:"spec,omitempty"`
}

Indicates the priority of an execution.

type CoreQualityOfServiceSpec ¶ added in v0.18.15 

type CoreQualityOfServiceSpec struct {
	// Indicates how much queueing delay an execution can tolerate.
	QueueingBudget string `json:"queueing_budget,omitempty"`
}

Represents customized execution run-time attributes.

type CoreResourceType ¶ 

type CoreResourceType string

CoreResourceType : Indicates a resource type within Flyte. - DATASET: A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects. Eventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects in a similar manner to other Flyte objects 

const (
	CoreResourceTypeUNSPECIFIED CoreResourceType = "UNSPECIFIED"
	CoreResourceTypeTASK        CoreResourceType = "TASK"
	CoreResourceTypeWORKFLOW    CoreResourceType = "WORKFLOW"
	CoreResourceTypeLAUNCH_PLAN CoreResourceType = "LAUNCH_PLAN"
	CoreResourceTypeDATASET     CoreResourceType = "DATASET"
)

List of coreResourceType

type CoreResources ¶ 

type CoreResources struct {
	// The desired set of resources requested. ResourceNames must be unique within the list.
	Requests []ResourcesResourceEntry `json:"requests,omitempty"`
	// Defines a set of bounds (e.g. min/max) within which the task can reliably run. ResourceNames must be unique within the list.
	Limits []ResourcesResourceEntry `json:"limits,omitempty"`
}

A customizable interface to convey resources requested for a container. This can be interpreted differently for different container engines.

type CoreRetryStrategy ¶ 

type CoreRetryStrategy struct {
	// Number of retries. Retries will be consumed when the job fails with a recoverable error. The number of retries must be less than or equals to 10.
	Retries int64 `json:"retries,omitempty"`
}

Retry strategy associated with an executable unit.

type CoreRuntimeMetadata ¶ 

type CoreRuntimeMetadata struct {
	// Type of runtime.
	Type_ *RuntimeMetadataRuntimeType `json:"type,omitempty"`
	// Version of the runtime. All versions should be backward compatible. However, certain cases call for version checks to ensure tighter validation or setting expectations.
	Version string `json:"version,omitempty"`
	// +optional It can be used to provide extra information about the runtime (e.g. python, golang... etc.).
	Flavor string `json:"flavor,omitempty"`
}

Runtime information. This is loosely defined to allow for extensibility.

type CoreScalar ¶ 

type CoreScalar struct {
	Primitive         *CorePrimitive         `json:"primitive,omitempty"`
	Blob              *CoreBlob              `json:"blob,omitempty"`
	Binary            *CoreBinary            `json:"binary,omitempty"`
	Schema            *CoreSchema            `json:"schema,omitempty"`
	NoneType          *CoreVoid              `json:"none_type,omitempty"`
	Error_            *CoreError             `json:"error,omitempty"`
	Generic           *ProtobufStruct        `json:"generic,omitempty"`
	StructuredDataset *CoreStructuredDataset `json:"structured_dataset,omitempty"`
	Union             *CoreUnion             `json:"union,omitempty"`
}

type CoreSchema ¶ added in v1.2.9 

type CoreSchema struct {
	Uri   string          `json:"uri,omitempty"`
	Type_ *CoreSchemaType `json:"type,omitempty"`
}

A strongly typed schema that defines the interface of data retrieved from the underlying storage medium.

type CoreSchemaType ¶ 

type CoreSchemaType struct {
	// A list of ordered columns this schema comprises of.
	Columns []SchemaTypeSchemaColumn `json:"columns,omitempty"`
}

Defines schema columns and types to strongly type-validate schemas interoperability.

type CoreSecret ¶ added in v0.18.16 

type CoreSecret struct {
	Group            string           `json:"group,omitempty"`
	GroupVersion     string           `json:"group_version,omitempty"`
	Key              string           `json:"key,omitempty"`
	MountRequirement *SecretMountType `json:"mount_requirement,omitempty"`
}

Secret encapsulates information about the secret a task needs to proceed. An environment variable FLYTE_SECRETS_ENV_PREFIX will be passed to indicate the prefix of the environment variables that will be present if secrets are passed through environment variables. FLYTE_SECRETS_DEFAULT_DIR will be passed to indicate the prefix of the path where secrets will be mounted if secrets are passed through file mounts.

type CoreSecurityContext ¶ added in v0.18.16 

type CoreSecurityContext struct {
	// run_as encapsulates the identity a pod should run as. If the task fills in multiple fields here, it'll be up to the backend plugin to choose the appropriate identity for the execution engine the task will run on.
	RunAs *CoreIdentity `json:"run_as,omitempty"`
	// secrets indicate the list of secrets the task needs in order to proceed. Secrets will be mounted/passed to the pod as it starts. If the plugin responsible for kicking of the task will not run it on a flyte cluster (e.g. AWS Batch), it's the responsibility of the plugin to fetch the secret (which means propeller identity will need access to the secret) and to pass it to the remote execution engine.
	Secrets []CoreSecret `json:"secrets,omitempty"`
	// tokens indicate the list of token requests the task needs in order to proceed. Tokens will be mounted/passed to the pod as it starts. If the plugin responsible for kicking of the task will not run it on a flyte cluster (e.g. AWS Batch), it's the responsibility of the plugin to fetch the secret (which means propeller identity will need access to the secret) and to pass it to the remote execution engine.
	Tokens []CoreOAuth2TokenRequest `json:"tokens,omitempty"`
}

SecurityContext holds security attributes that apply to tasks.

type CoreSignalCondition ¶ added in v1.2.1 

type CoreSignalCondition struct {
	// A unique identifier for the requested signal.
	SignalId string `json:"signal_id,omitempty"`
	// A type denoting the required value type for this signal.
	Type_ *CoreLiteralType `json:"type,omitempty"`
	// The variable name for the signal value in this nodes outputs.
	OutputVariableName string `json:"output_variable_name,omitempty"`
}

SignalCondition represents a dependency on an signal.

type CoreSimpleType ¶ 

type CoreSimpleType string

CoreSimpleType : Define a set of simple types. 

const (
	CoreSimpleTypeNONE     CoreSimpleType = "NONE"
	CoreSimpleTypeINTEGER  CoreSimpleType = "INTEGER"
	CoreSimpleTypeFLOAT    CoreSimpleType = "FLOAT"
	CoreSimpleTypeSTRING_  CoreSimpleType = "STRING"
	CoreSimpleTypeBOOLEAN  CoreSimpleType = "BOOLEAN"
	CoreSimpleTypeDATETIME CoreSimpleType = "DATETIME"
	CoreSimpleTypeDURATION CoreSimpleType = "DURATION"
	CoreSimpleTypeBINARY   CoreSimpleType = "BINARY"
	CoreSimpleTypeERROR_   CoreSimpleType = "ERROR"
	CoreSimpleTypeSTRUCT_  CoreSimpleType = "STRUCT"
)

List of coreSimpleType

type CoreSleepCondition ¶ added in v1.2.1 

type CoreSleepCondition struct {
	// The overall duration for this sleep.
	Duration string `json:"duration,omitempty"`
}

SleepCondition represents a dependency on waiting for the specified duration.

type CoreSpan ¶ added in v1.2.10 

type CoreSpan struct {
	// start_time defines the instance this span began.
	StartTime time.Time `json:"start_time,omitempty"`
	// end_time defines the instance this span completed.
	EndTime time.Time `json:"end_time,omitempty"`
	// workflow_id is the id of the workflow execution this Span represents.
	WorkflowId *CoreWorkflowExecutionIdentifier `json:"workflow_id,omitempty"`
	// node_id is the id of the node execution this Span represents.
	NodeId *CoreNodeExecutionIdentifier `json:"node_id,omitempty"`
	// task_id is the id of the task execution this Span represents.
	TaskId *CoreTaskExecutionIdentifier `json:"task_id,omitempty"`
	// operation_id is the id of a unique operation that this Span represents.
	OperationId string `json:"operation_id,omitempty"`
	// spans defines a collection of Spans that breakdown this execution.
	Spans []CoreSpan `json:"spans,omitempty"`
}

Span represents a duration trace of Flyte execution. The id field denotes a Flyte execution entity or an operation which uniquely identifies the Span. The spans attribute allows this Span to be further broken down into more precise definitions.

type CoreSql ¶ added in v0.20.1 

type CoreSql struct {
	Statement string      `json:"statement,omitempty"`
	Dialect   *SqlDialect `json:"dialect,omitempty"`
}

Sql represents a generic sql workload with a statement and dialect.

type CoreStructuredDataset ¶ added in v0.21.17 

type CoreStructuredDataset struct {
	Uri      string                         `json:"uri,omitempty"`
	Metadata *CoreStructuredDatasetMetadata `json:"metadata,omitempty"`
}

type CoreStructuredDatasetMetadata ¶ added in v0.21.17 

type CoreStructuredDatasetMetadata struct {
	// Bundle the type information along with the literal. This is here because StructuredDatasets can often be more defined at run time than at compile time. That is, at compile time you might only declare a task to return a pandas dataframe or a StructuredDataset, without any column information, but at run time, you might have that column information. flytekit python will copy this type information into the literal, from the type information, if not provided by the various plugins (encoders). Since this field is run time generated, it's not used for any type checking.
	StructuredDatasetType *CoreStructuredDatasetType `json:"structured_dataset_type,omitempty"`
}

type CoreStructuredDatasetType ¶ added in v0.21.17 

type CoreStructuredDatasetType struct {
	// A list of ordered columns this schema comprises of.
	Columns []StructuredDatasetTypeDatasetColumn `json:"columns,omitempty"`
	// This is the storage format, the format of the bits at rest parquet, feather, csv, etc. For two types to be compatible, the format will need to be an exact match.
	Format string `json:"format,omitempty"`
	// This is a string representing the type that the bytes in external_schema_bytes are formatted in. This is an optional field that will not be used for type checking.
	ExternalSchemaType string `json:"external_schema_type,omitempty"`
	// The serialized bytes of a third-party schema library like Arrow. This is an optional field that will not be used for type checking.
	ExternalSchemaBytes string `json:"external_schema_bytes,omitempty"`
}

type CoreTaskExecutionIdentifier ¶ 

type CoreTaskExecutionIdentifier struct {
	TaskId          *CoreIdentifier              `json:"task_id,omitempty"`
	NodeExecutionId *CoreNodeExecutionIdentifier `json:"node_execution_id,omitempty"`
	RetryAttempt    int64                        `json:"retry_attempt,omitempty"`
}

Encapsulation of fields that identify a Flyte task execution entity.

type CoreTaskExecutionPhase ¶ 

type CoreTaskExecutionPhase string
const (
	CoreTaskExecutionPhaseUNDEFINED             CoreTaskExecutionPhase = "UNDEFINED"
	CoreTaskExecutionPhaseQUEUED                CoreTaskExecutionPhase = "QUEUED"
	CoreTaskExecutionPhaseRUNNING               CoreTaskExecutionPhase = "RUNNING"
	CoreTaskExecutionPhaseSUCCEEDED             CoreTaskExecutionPhase = "SUCCEEDED"
	CoreTaskExecutionPhaseABORTED               CoreTaskExecutionPhase = "ABORTED"
	CoreTaskExecutionPhaseFAILED                CoreTaskExecutionPhase = "FAILED"
	CoreTaskExecutionPhaseINITIALIZING          CoreTaskExecutionPhase = "INITIALIZING"
	CoreTaskExecutionPhaseWAITING_FOR_RESOURCES CoreTaskExecutionPhase = "WAITING_FOR_RESOURCES"
)

List of coreTaskExecutionPhase

type CoreTaskLog ¶ 

type CoreTaskLog struct {
	Uri           string                `json:"uri,omitempty"`
	Name          string                `json:"name,omitempty"`
	MessageFormat *TaskLogMessageFormat `json:"message_format,omitempty"`
	Ttl           string                `json:"ttl,omitempty"`
}

type CoreTaskMetadata ¶ 

type CoreTaskMetadata struct {
	// Indicates whether the system should attempt to lookup this task's output to avoid duplication of work.
	Discoverable bool `json:"discoverable,omitempty"`
	// Runtime information about the task.
	Runtime *CoreRuntimeMetadata `json:"runtime,omitempty"`
	// The overall timeout of a task including user-triggered retries.
	Timeout string `json:"timeout,omitempty"`
	// Number of retries per task.
	Retries *CoreRetryStrategy `json:"retries,omitempty"`
	// Indicates a logical version to apply to this task for the purpose of discovery.
	DiscoveryVersion string `json:"discovery_version,omitempty"`
	// If set, this indicates that this task is deprecated.  This will enable owners of tasks to notify consumers of the ending of support for a given task.
	DeprecatedErrorMessage string `json:"deprecated_error_message,omitempty"`
	Interruptible          bool   `json:"interruptible,omitempty"`
	CacheSerializable      bool   `json:"cache_serializable,omitempty"`
	// Indicates whether the task will generate a Deck URI when it finishes executing.
	GeneratesDeck bool              `json:"generates_deck,omitempty"`
	Tags          map[string]string `json:"tags,omitempty"`
	// pod_template_name is the unique name of a PodTemplate k8s resource to be used as the base configuration if this task creates a k8s Pod. If this value is set, the specified PodTemplate will be used instead of, but applied identically as, the default PodTemplate configured in FlytePropeller.
	PodTemplateName string `json:"pod_template_name,omitempty"`
}

type CoreTaskNode ¶ 

type CoreTaskNode struct {
	// A globally unique identifier for the task.
	ReferenceId *CoreIdentifier `json:"reference_id,omitempty"`
	// Optional overrides applied at task execution time.
	Overrides *CoreTaskNodeOverrides `json:"overrides,omitempty"`
}

Refers to the task that the Node is to execute.

type CoreTaskNodeOverrides ¶ added in v0.19.5 

type CoreTaskNodeOverrides struct {
	// A customizable interface to convey resources requested for a task container.
	Resources *CoreResources `json:"resources,omitempty"`
}

Optional task node overrides that will be applied at task execution time.

type CoreTaskTemplate ¶ 

type CoreTaskTemplate struct {
	// Auto generated taskId by the system. Task Id uniquely identifies this task globally.
	Id *CoreIdentifier `json:"id,omitempty"`
	// A predefined yet extensible Task type identifier. This can be used to customize any of the components. If no extensions are provided in the system, Flyte will resolve the this task to its TaskCategory and default the implementation registered for the TaskCategory.
	Type_ string `json:"type,omitempty"`
	// Extra metadata about the task.
	Metadata *CoreTaskMetadata `json:"metadata,omitempty"`
	// A strongly typed interface for the task. This enables others to use this task within a workflow and guarantees compile-time validation of the workflow to avoid costly runtime failures.
	Interface_ *CoreTypedInterface `json:"interface,omitempty"`
	// Custom data about the task. This is extensible to allow various plugins in the system.
	Custom    *ProtobufStruct `json:"custom,omitempty"`
	Container *CoreContainer  `json:"container,omitempty"`
	K8sPod    *CoreK8sPod     `json:"k8s_pod,omitempty"`
	Sql       *CoreSql        `json:"sql,omitempty"`
	// This can be used to customize task handling at execution time for the same task type.
	TaskTypeVersion int32 `json:"task_type_version,omitempty"`
	// security_context encapsulates security attributes requested to run this task.
	SecurityContext *CoreSecurityContext `json:"security_context,omitempty"`
	Config          map[string]string    `json:"config,omitempty"`
}

A Task structure that uniquely identifies a task in the system Tasks are registered as a first step in the system.

type CoreTypeAnnotation ¶ added in v0.22.0 

type CoreTypeAnnotation struct {
	// A arbitrary JSON payload to describe a type.
	Annotations *ProtobufStruct `json:"annotations,omitempty"`
}

TypeAnnotation encapsulates registration time information about a type. This can be used for various control-plane operations. TypeAnnotation will not be available at runtime when a task runs.

type CoreTypeStructure ¶ added in v0.24.0 

type CoreTypeStructure struct {
	Tag string `json:"tag,omitempty"`
}

Hints to improve type matching e.g. allows distinguishing output from custom type transformers even if the underlying IDL serialization matches.

type CoreTypedInterface ¶ 

type CoreTypedInterface struct {
	Inputs  *CoreVariableMap `json:"inputs,omitempty"`
	Outputs *CoreVariableMap `json:"outputs,omitempty"`
}

Defines strongly typed inputs and outputs.

type CoreUnion ¶ added in v0.24.0 

type CoreUnion struct {
	Value *CoreLiteral     `json:"value,omitempty"`
	Type_ *CoreLiteralType `json:"type,omitempty"`
}

The runtime representation of a tagged union value. See `UnionType` for more details.

type CoreUnionInfo ¶ added in v0.24.0 

type CoreUnionInfo struct {
	TargetType *CoreLiteralType `json:"targetType,omitempty"`
}

type CoreUnionType ¶ added in v0.24.0 

type CoreUnionType struct {
	// Predefined set of variants in union.
	Variants []CoreLiteralType `json:"variants,omitempty"`
}

Defines a tagged union type, also known as a variant (and formally as the sum type). A sum type S is defined by a sequence of types (A, B, C, ...), each tagged by a string tag A value of type S is constructed from a value of any of the variant types. The specific choice of type is recorded by storing the varaint's tag with the literal value and can be examined in runtime. Type S is typically written as S := Apple A | Banana B | Cantaloupe C | ... Notably, a nullable (optional) type is a sum type between some type X and the singleton type representing a null-value: Optional X := X | Null See also: https://en.wikipedia.org/wiki/Tagged_union

type CoreVariable ¶ 

type CoreVariable struct {
	// Variable literal type.
	Type_       *CoreLiteralType `json:"type,omitempty"`
	Description string           `json:"description,omitempty"`
}

Defines a strongly typed variable.

type CoreVariableMap ¶ 

type CoreVariableMap struct {
	// Defines a map of variable names to variables.
	Variables map[string]CoreVariable `json:"variables,omitempty"`
}

type CoreVoid ¶ 

type CoreVoid struct {
}

Used to denote a nil/null/None assignment to a scalar value. The underlying LiteralType for Void is intentionally undefined since it can be assigned to a scalar of any LiteralType.

type CoreWorkflowExecutionIdentifier ¶ 

type CoreWorkflowExecutionIdentifier struct {
	// Name of the project the resource belongs to.
	Project string `json:"project,omitempty"`
	// Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project.
	Domain string `json:"domain,omitempty"`
	// User or system provided value for the resource.
	Name string `json:"name,omitempty"`
}

type CoreWorkflowExecutionPhase ¶ 

type CoreWorkflowExecutionPhase string
const (
	CoreWorkflowExecutionPhaseUNDEFINED  CoreWorkflowExecutionPhase = "UNDEFINED"
	CoreWorkflowExecutionPhaseQUEUED     CoreWorkflowExecutionPhase = "QUEUED"
	CoreWorkflowExecutionPhaseRUNNING    CoreWorkflowExecutionPhase = "RUNNING"
	CoreWorkflowExecutionPhaseSUCCEEDING CoreWorkflowExecutionPhase = "SUCCEEDING"
	CoreWorkflowExecutionPhaseSUCCEEDED  CoreWorkflowExecutionPhase = "SUCCEEDED"
	CoreWorkflowExecutionPhaseFAILING    CoreWorkflowExecutionPhase = "FAILING"
	CoreWorkflowExecutionPhaseFAILED     CoreWorkflowExecutionPhase = "FAILED"
	CoreWorkflowExecutionPhaseABORTED    CoreWorkflowExecutionPhase = "ABORTED"
	CoreWorkflowExecutionPhaseTIMED_OUT  CoreWorkflowExecutionPhase = "TIMED_OUT"
	CoreWorkflowExecutionPhaseABORTING   CoreWorkflowExecutionPhase = "ABORTING"
)

List of coreWorkflowExecutionPhase

type CoreWorkflowMetadata ¶ 

type CoreWorkflowMetadata struct {
	// Indicates the runtime priority of workflow executions.
	QualityOfService *CoreQualityOfService `json:"quality_of_service,omitempty"`
	// Defines how the system should behave when a failure is detected in the workflow execution.
	OnFailure *WorkflowMetadataOnFailurePolicy `json:"on_failure,omitempty"`
	Tags      map[string]string                `json:"tags,omitempty"`
}

This is workflow layer metadata. These settings are only applicable to the workflow as a whole, and do not percolate down to child entities (like tasks) launched by the workflow.

type CoreWorkflowMetadataDefaults ¶ added in v0.18.15 

type CoreWorkflowMetadataDefaults struct {
	// Whether child nodes of the workflow are interruptible.
	Interruptible bool `json:"interruptible,omitempty"`
}

The difference between these settings and the WorkflowMetadata ones is that these are meant to be passed down to a workflow's underlying entities (like tasks). For instance, 'interruptible' has no meaning at the workflow layer, it is only relevant when a task executes. The settings here are the defaults that are passed to all nodes unless explicitly overridden at the node layer. If you are adding a setting that applies to both the Workflow itself, and everything underneath it, it should be added to both this object and the WorkflowMetadata object above.

type CoreWorkflowNode ¶ 

type CoreWorkflowNode struct {
	// A globally unique identifier for the launch plan.
	LaunchplanRef  *CoreIdentifier `json:"launchplan_ref,omitempty"`
	SubWorkflowRef *CoreIdentifier `json:"sub_workflow_ref,omitempty"`
}

Refers to a the workflow the node is to execute.

type CoreWorkflowTemplate ¶ 

type CoreWorkflowTemplate struct {
	// A globally unique identifier for the workflow.
	Id *CoreIdentifier `json:"id,omitempty"`
	// Extra metadata about the workflow.
	Metadata *CoreWorkflowMetadata `json:"metadata,omitempty"`
	// Defines a strongly typed interface for the Workflow. This can include some optional parameters.
	Interface_ *CoreTypedInterface `json:"interface,omitempty"`
	// A list of nodes. In addition, 'globals' is a special reserved node id that can be used to consume workflow inputs.
	Nodes []CoreNode `json:"nodes,omitempty"`
	// A list of output bindings that specify how to construct workflow outputs. Bindings can pull node outputs or specify literals. All workflow outputs specified in the interface field must be bound in order for the workflow to be validated. A workflow has an implicit dependency on all of its nodes to execute successfully in order to bind final outputs. Most of these outputs will be Binding's with a BindingData of type OutputReference.  That is, your workflow can just have an output of some constant (`Output(5)`), but usually, the workflow will be pulling outputs from the output of a task.
	Outputs []CoreBinding `json:"outputs,omitempty"`
	// +optional A catch-all node. This node is executed whenever the execution engine determines the workflow has failed. The interface of this node must match the Workflow interface with an additional input named 'error' of type pb.lyft.flyte.core.Error.
	FailureNode      *CoreNode                     `json:"failure_node,omitempty"`
	MetadataDefaults *CoreWorkflowMetadataDefaults `json:"metadata_defaults,omitempty"`
}

Flyte Workflow Structure that encapsulates task, branch and subworkflow nodes to form a statically analyzable, directed acyclic graph.

type DataLoadingConfigLiteralMapFormat ¶ added in v0.18.15 

type DataLoadingConfigLiteralMapFormat string

DataLoadingConfigLiteralMapFormat : - JSON: JSON / YAML for the metadata (which contains inlined primitive values). The representation is inline with the standard json specification as specified - https://www.json.org/json-en.html - PROTO: Proto is a serialized binary of `core.LiteralMap` defined in flyteidl/core 

const (
	DataLoadingConfigLiteralMapFormatJSON  DataLoadingConfigLiteralMapFormat = "JSON"
	DataLoadingConfigLiteralMapFormatYAML  DataLoadingConfigLiteralMapFormat = "YAML"
	DataLoadingConfigLiteralMapFormatPROTO DataLoadingConfigLiteralMapFormat = "PROTO"
)

List of DataLoadingConfigLiteralMapFormat

type EventEventReason ¶ added in v1.5.21 

type EventEventReason struct {
	Reason     string    `json:"reason,omitempty"`
	OccurredAt time.Time `json:"occurred_at,omitempty"`
}

type EventExternalResourceInfo ¶ added in v0.18.23 

type EventExternalResourceInfo struct {
	// Identifier for an external resource created by this task execution, for example Qubole query ID or presto query ids.
	ExternalId string `json:"external_id,omitempty"`
	// A unique index for the external resource with respect to all external resources for this task. Although the identifier may change between task reporting events or retries, this will remain the same to enable aggregating information from multiple reports.
	Index        int64                   `json:"index,omitempty"`
	RetryAttempt int64                   `json:"retry_attempt,omitempty"`
	Phase        *CoreTaskExecutionPhase `json:"phase,omitempty"`
	// Captures the status of caching for this external resource execution.
	CacheStatus *CoreCatalogCacheStatus `json:"cache_status,omitempty"`
	Logs        []CoreTaskLog           `json:"logs,omitempty"`
}

This message contains metadata about external resources produced or used by a specific task execution.

type EventNodeExecutionEvent ¶ 

type EventNodeExecutionEvent struct {
	Id         *CoreNodeExecutionIdentifier `json:"id,omitempty"`
	ProducerId string                       `json:"producer_id,omitempty"`
	Phase      *CoreNodeExecutionPhase      `json:"phase,omitempty"`
	// This timestamp represents when the original event occurred, it is generated by the executor of the node.
	OccurredAt time.Time `json:"occurred_at,omitempty"`
	InputUri   string    `json:"input_uri,omitempty"`
	// Raw input data consumed by this node execution.
	InputData *CoreLiteralMap `json:"input_data,omitempty"`
	// URL to the output of the execution, it encodes all the information including Cloud source provider. ie., s3://...
	OutputUri string              `json:"output_uri,omitempty"`
	Error_    *CoreExecutionError `json:"error,omitempty"`
	// Raw output data produced by this node execution.
	OutputData           *CoreLiteralMap                    `json:"output_data,omitempty"`
	WorkflowNodeMetadata *FlyteidleventWorkflowNodeMetadata `json:"workflow_node_metadata,omitempty"`
	TaskNodeMetadata     *FlyteidleventTaskNodeMetadata     `json:"task_node_metadata,omitempty"`
	// [To be deprecated] Specifies which task (if any) launched this node.
	ParentTaskMetadata *EventParentTaskExecutionMetadata `json:"parent_task_metadata,omitempty"`
	// Specifies the parent node of the current node execution. Node executions at level zero will not have a parent node.
	ParentNodeMetadata *EventParentNodeExecutionMetadata `json:"parent_node_metadata,omitempty"`
	RetryGroup         string                            `json:"retry_group,omitempty"`
	SpecNodeId         string                            `json:"spec_node_id,omitempty"`
	NodeName           string                            `json:"node_name,omitempty"`
	EventVersion       int32                             `json:"event_version,omitempty"`
	// Whether this node launched a subworkflow.
	IsParent bool `json:"is_parent,omitempty"`
	// Whether this node yielded a dynamic workflow.
	IsDynamic bool   `json:"is_dynamic,omitempty"`
	DeckUri   string `json:"deck_uri,omitempty"`
	// This timestamp represents the instant when the event was reported by the executing framework. For example, when first processing a node the `occurred_at` timestamp should be the instant propeller makes progress, so when literal inputs are initially copied. The event however will not be sent until after the copy completes. Extracting both of these timestamps facilitates a more accurate portrayal of the evaluation time-series.
	ReportedAt time.Time `json:"reported_at,omitempty"`
}

type EventParentNodeExecutionMetadata ¶ added in v0.18.15 

type EventParentNodeExecutionMetadata struct {
	NodeId string `json:"node_id,omitempty"`
}

type EventParentTaskExecutionMetadata ¶ 

type EventParentTaskExecutionMetadata struct {
	Id *CoreTaskExecutionIdentifier `json:"id,omitempty"`
}

type EventResourcePoolInfo ¶ added in v0.18.23 

type EventResourcePoolInfo struct {
	// Unique resource ID used to identify this execution when allocating a token.
	AllocationToken string `json:"allocation_token,omitempty"`
	// Namespace under which this task execution requested an allocation token.
	Namespace string `json:"namespace,omitempty"`
}

This message holds task execution metadata specific to resource allocation used to manage concurrent executions for a project namespace.

type EventTaskExecutionEvent ¶ 

type EventTaskExecutionEvent struct {
	// ID of the task. In combination with the retryAttempt this will indicate the task execution uniquely for a given parent node execution.
	TaskId                *CoreIdentifier              `json:"task_id,omitempty"`
	ParentNodeExecutionId *CoreNodeExecutionIdentifier `json:"parent_node_execution_id,omitempty"`
	RetryAttempt          int64                        `json:"retry_attempt,omitempty"`
	Phase                 *CoreTaskExecutionPhase      `json:"phase,omitempty"`
	ProducerId            string                       `json:"producer_id,omitempty"`
	Logs                  []CoreTaskLog                `json:"logs,omitempty"`
	// This timestamp represents when the original event occurred, it is generated by the executor of the task.
	OccurredAt time.Time `json:"occurred_at,omitempty"`
	// URI of the input file, it encodes all the information including Cloud source provider. ie., s3://...
	InputUri string `json:"input_uri,omitempty"`
	// Raw input data consumed by this task execution.
	InputData *CoreLiteralMap `json:"input_data,omitempty"`
	// URI to the output of the execution, it will be in a format that encodes all the information including Cloud source provider. ie., s3://...
	OutputUri string              `json:"output_uri,omitempty"`
	Error_    *CoreExecutionError `json:"error,omitempty"`
	// Raw output data produced by this task execution.
	OutputData *CoreLiteralMap `json:"output_data,omitempty"`
	// Custom data that the task plugin sends back. This is extensible to allow various plugins in the system.
	CustomInfo *ProtobufStruct `json:"custom_info,omitempty"`
	// Some phases, like RUNNING, can send multiple events with changed metadata (new logs, additional custom_info, etc) that should be recorded regardless of the lack of phase change. The version field should be incremented when metadata changes across the duration of an individual phase.
	PhaseVersion int64 `json:"phase_version,omitempty"`
	// An optional explanation for the phase transition. Deprecated: Use reasons instead.
	Reason string `json:"reason,omitempty"`
	// An optional list of explanations for the phase transition.
	Reasons []EventEventReason `json:"reasons,omitempty"`
	// A predefined yet extensible Task type identifier. If the task definition is already registered in flyte admin this type will be identical, but not all task executions necessarily use pre-registered definitions and this type is useful to render the task in the UI, filter task executions, etc.
	TaskType string `json:"task_type,omitempty"`
	// Metadata around how a task was executed.
	Metadata *FlyteidleventTaskExecutionMetadata `json:"metadata,omitempty"`
	// The event version is used to indicate versioned changes in how data is reported using this proto message. For example, event_verison > 0 means that maps tasks report logs using the TaskExecutionMetadata ExternalResourceInfo fields for each subtask rather than the TaskLog in this message.
	EventVersion int32 `json:"event_version,omitempty"`
	// This timestamp represents the instant when the event was reported by the executing framework. For example, a k8s pod task may be marked completed at (ie. `occurred_at`) the instant the container running user code completes, but this event will not be reported until the pod is marked as completed. Extracting both of these timestamps facilitates a more accurate portrayal of the evaluation time-series.
	ReportedAt time.Time `json:"reported_at,omitempty"`
}

Plugin specific execution event information. For tasks like Python, Hive, Spark, DynamicJob.

type EventWorkflowExecutionEvent ¶ 

type EventWorkflowExecutionEvent struct {
	ExecutionId *CoreWorkflowExecutionIdentifier `json:"execution_id,omitempty"`
	ProducerId  string                           `json:"producer_id,omitempty"`
	Phase       *CoreWorkflowExecutionPhase      `json:"phase,omitempty"`
	// This timestamp represents when the original event occurred, it is generated by the executor of the workflow.
	OccurredAt time.Time `json:"occurred_at,omitempty"`
	// URL to the output of the execution, it encodes all the information including Cloud source provider. ie., s3://...
	OutputUri string              `json:"output_uri,omitempty"`
	Error_    *CoreExecutionError `json:"error,omitempty"`
	// Raw output data produced by this workflow execution.
	OutputData *CoreLiteralMap `json:"output_data,omitempty"`
}

type ExecutionErrorErrorKind ¶ added in v0.18.15 

type ExecutionErrorErrorKind string
const (
	ExecutionErrorErrorKindUNKNOWN ExecutionErrorErrorKind = "UNKNOWN"
	ExecutionErrorErrorKindUSER    ExecutionErrorErrorKind = "USER"
	ExecutionErrorErrorKindSYSTEM  ExecutionErrorErrorKind = "SYSTEM"
)

List of ExecutionErrorErrorKind

type ExecutionMetadataExecutionMode ¶ 

type ExecutionMetadataExecutionMode string

ExecutionMetadataExecutionMode : The method by which this execution was launched. - MANUAL: The default execution mode, MANUAL implies that an execution was launched by an individual. - SCHEDULED: A schedule triggered this execution launch. - SYSTEM: A system process was responsible for launching this execution rather an individual. - RELAUNCH: This execution was launched with identical inputs as a previous execution. - CHILD_WORKFLOW: This execution was triggered by another execution. - RECOVERED: This execution was recovered from another execution. 

const (
	ExecutionMetadataExecutionModeMANUAL         ExecutionMetadataExecutionMode = "MANUAL"
	ExecutionMetadataExecutionModeSCHEDULED      ExecutionMetadataExecutionMode = "SCHEDULED"
	ExecutionMetadataExecutionModeSYSTEM         ExecutionMetadataExecutionMode = "SYSTEM"
	ExecutionMetadataExecutionModeRELAUNCH       ExecutionMetadataExecutionMode = "RELAUNCH"
	ExecutionMetadataExecutionModeCHILD_WORKFLOW ExecutionMetadataExecutionMode = "CHILD_WORKFLOW"
	ExecutionMetadataExecutionModeRECOVERED      ExecutionMetadataExecutionMode = "RECOVERED"
)

List of ExecutionMetadataExecutionMode

type FlyteidladminDynamicWorkflowNodeMetadata ¶ added in v0.18.33 

type FlyteidladminDynamicWorkflowNodeMetadata struct {
	// id represents the unique identifier of the workflow.
	Id *CoreIdentifier `json:"id,omitempty"`
	// Represents the compiled representation of the embedded dynamic workflow.
	CompiledWorkflow *CoreCompiledWorkflowClosure `json:"compiled_workflow,omitempty"`
	// dynamic_job_spec_uri is the location of the DynamicJobSpec proto message for this DynamicWorkflow. This is required to correctly recover partially completed executions where the subworkflow has already been compiled.
	DynamicJobSpecUri string `json:"dynamic_job_spec_uri,omitempty"`
}

For dynamic workflow nodes we capture information about the dynamic workflow definition that gets generated.

type FlyteidladminNodeExecution ¶ 

type FlyteidladminNodeExecution struct {
	// Uniquely identifies an individual node execution.
	Id *CoreNodeExecutionIdentifier `json:"id,omitempty"`
	// Path to remote data store where input blob is stored.
	InputUri string `json:"input_uri,omitempty"`
	// Computed results associated with this node execution.
	Closure  *AdminNodeExecutionClosure  `json:"closure,omitempty"`
	Metadata *AdminNodeExecutionMetaData `json:"metadata,omitempty"`
}

Encapsulates all details for a single node execution entity. A node represents a component in the overall workflow graph. A node launch a task, multiple tasks, an entire nested sub-workflow, or even a separate child-workflow execution. The same task can be called repeatedly in a single workflow but each node is unique.

type FlyteidladminTaskCreateRequest ¶ added in v1.2.10 

type FlyteidladminTaskCreateRequest struct {
	Id   *CoreIdentifier `json:"id,omitempty"`
	Spec *AdminTaskSpec  `json:"spec,omitempty"`
}

type FlyteidladminTaskCreateResponse ¶ added in v1.2.10 

type FlyteidladminTaskCreateResponse struct {
}

Represents a response structure if task creation succeeds.

type FlyteidladminTaskExecution ¶ 

type FlyteidladminTaskExecution struct {
	// Unique identifier for the task execution.
	Id *CoreTaskExecutionIdentifier `json:"id,omitempty"`
	// Path to remote data store where input blob is stored.
	InputUri string `json:"input_uri,omitempty"`
	// Task execution details and results.
	Closure *AdminTaskExecutionClosure `json:"closure,omitempty"`
	// Whether this task spawned nodes.
	IsParent bool `json:"is_parent,omitempty"`
}

Encapsulates all details for a single task execution entity. A task execution represents an instantiated task, including all inputs and additional metadata as well as computed results included state, outputs, and duration-based attributes.

type FlyteidladminTaskNodeMetadata ¶ added in v0.18.15 

type FlyteidladminTaskNodeMetadata struct {
	// Captures the status of caching for this execution.
	CacheStatus   *CoreCatalogCacheStatus `json:"cache_status,omitempty"`
	CatalogKey    *CoreCatalogMetadata    `json:"catalog_key,omitempty"`
	CheckpointUri string                  `json:"checkpoint_uri,omitempty"`
}

type FlyteidladminWorkflowNodeMetadata ¶ 

type FlyteidladminWorkflowNodeMetadata struct {
	// The identifier for a workflow execution launched by a node.
	ExecutionId *CoreWorkflowExecutionIdentifier `json:"executionId,omitempty"`
}

type FlyteidleventDynamicWorkflowNodeMetadata ¶ added in v0.18.33 

type FlyteidleventDynamicWorkflowNodeMetadata struct {
	// id represents the unique identifier of the workflow.
	Id *CoreIdentifier `json:"id,omitempty"`
	// Represents the compiled representation of the embedded dynamic workflow.
	CompiledWorkflow *CoreCompiledWorkflowClosure `json:"compiled_workflow,omitempty"`
	// dynamic_job_spec_uri is the location of the DynamicJobSpec proto message for this DynamicWorkflow. This is required to correctly recover partially completed executions where the workflow has already been compiled.
	DynamicJobSpecUri string `json:"dynamic_job_spec_uri,omitempty"`
}

For dynamic workflow nodes we send information about the dynamic workflow definition that gets generated.

type FlyteidleventTaskExecutionMetadata ¶ added in v1.5.13 

type FlyteidleventTaskExecutionMetadata struct {
	// Unique, generated name for this task execution used by the backend.
	GeneratedName string `json:"generated_name,omitempty"`
	// Additional data on external resources on other back-ends or platforms (e.g. Hive, Qubole, etc) launched by this task execution.
	ExternalResources []EventExternalResourceInfo `json:"external_resources,omitempty"`
	// Includes additional data on concurrent resource management used during execution.. This is a repeated field because a plugin can request multiple resource allocations during execution.
	ResourcePoolInfo []EventResourcePoolInfo `json:"resource_pool_info,omitempty"`
	// The identifier of the plugin used to execute this task.
	PluginIdentifier string                              `json:"plugin_identifier,omitempty"`
	InstanceClass    *TaskExecutionMetadataInstanceClass `json:"instance_class,omitempty"`
}

Holds metadata around how a task was executed. As a task transitions across event phases during execution some attributes, such its generated name, generated external resources, and more may grow in size but not change necessarily based on the phase transition that sparked the event update. Metadata is a container for these attributes across the task execution lifecycle.

type FlyteidleventTaskNodeMetadata ¶ added in v0.18.15 

type FlyteidleventTaskNodeMetadata struct {
	// Captures the status of caching for this execution.
	CacheStatus *CoreCatalogCacheStatus `json:"cache_status,omitempty"`
	CatalogKey  *CoreCatalogMetadata    `json:"catalog_key,omitempty"`
	// Captures the status of cache reservations for this execution.
	ReservationStatus *CatalogReservationStatus `json:"reservation_status,omitempty"`
	CheckpointUri     string                    `json:"checkpoint_uri,omitempty"`
	// In the case this task launched a dynamic workflow we capture its structure here.
	DynamicWorkflow *FlyteidleventDynamicWorkflowNodeMetadata `json:"dynamic_workflow,omitempty"`
}

type FlyteidleventWorkflowNodeMetadata ¶ 

type FlyteidleventWorkflowNodeMetadata struct {
	ExecutionId *CoreWorkflowExecutionIdentifier `json:"execution_id,omitempty"`
}

type GenericSwaggerError ¶ 

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶ 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶ 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶ 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetExecutionMetricsOpts ¶ added in v1.2.10 

type GetExecutionMetricsOpts struct {
	Depth optional.Int32
}

type GetLaunchPlanOpts ¶ 

type GetLaunchPlanOpts struct {
	IdResourceType optional.String
}

type GetProjectAttributesOpts ¶ added in v0.16.5 

type GetProjectAttributesOpts struct {
	ResourceType optional.String
}

type GetProjectDomainAttributesOpts ¶ added in v0.16.5 

type GetProjectDomainAttributesOpts struct {
	ResourceType optional.String
}

type GetTaskExecutionDataOpts ¶ 

type GetTaskExecutionDataOpts struct {
	IdTaskIdResourceType optional.String
}

type GetTaskExecutionOpts ¶ 

type GetTaskExecutionOpts struct {
	IdTaskIdResourceType optional.String
}

type GetTaskOpts ¶ 

type GetTaskOpts struct {
	IdResourceType optional.String
}

type GetWorkflowAttributesOpts ¶ added in v0.16.5 

type GetWorkflowAttributesOpts struct {
	ResourceType optional.String
}

type GetWorkflowOpts ¶ 

type GetWorkflowOpts struct {
	IdResourceType optional.String
}

type IoStrategyDownloadMode ¶ added in v0.18.15 

type IoStrategyDownloadMode string

IoStrategyDownloadMode : - DOWNLOAD_EAGER: All data will be downloaded before the main container is executed - DOWNLOAD_STREAM: Data will be downloaded as a stream and an End-Of-Stream marker will be written to indicate all data has been downloaded. Refer to protocol for details - DO_NOT_DOWNLOAD: Large objects (offloaded) will not be downloaded 

const (
	IoStrategyDownloadModeDOWNLOAD_EAGER  IoStrategyDownloadMode = "DOWNLOAD_EAGER"
	IoStrategyDownloadModeDOWNLOAD_STREAM IoStrategyDownloadMode = "DOWNLOAD_STREAM"
	IoStrategyDownloadModeDO_NOT_DOWNLOAD IoStrategyDownloadMode = "DO_NOT_DOWNLOAD"
)

List of IOStrategyDownloadMode

type IoStrategyUploadMode ¶ added in v0.18.15 

type IoStrategyUploadMode string

IoStrategyUploadMode : - UPLOAD_ON_EXIT: All data will be uploaded after the main container exits - UPLOAD_EAGER: Data will be uploaded as it appears. Refer to protocol specification for details - DO_NOT_UPLOAD: Data will not be uploaded, only references will be written 

const (
	IoStrategyUploadModeUPLOAD_ON_EXIT IoStrategyUploadMode = "UPLOAD_ON_EXIT"
	IoStrategyUploadModeUPLOAD_EAGER   IoStrategyUploadMode = "UPLOAD_EAGER"
	IoStrategyUploadModeDO_NOT_UPLOAD  IoStrategyUploadMode = "DO_NOT_UPLOAD"
)

List of IOStrategyUploadMode

type ListActiveLaunchPlansOpts ¶ added in v0.1.1 

type ListActiveLaunchPlansOpts struct {
	Limit           optional.Int64
	Token           optional.String
	SortByKey       optional.String
	SortByDirection optional.String
}

type ListDescriptionEntities2Opts ¶ added in v1.2.4 

type ListDescriptionEntities2Opts struct {
	IdName          optional.String
	Limit           optional.Int64
	Token           optional.String
	Filters         optional.String
	SortByKey       optional.String
	SortByDirection optional.String
}

type ListDescriptionEntitiesOpts ¶ added in v1.2.4 

type ListDescriptionEntitiesOpts struct {
	Limit           optional.Int64
	Token           optional.String
	Filters         optional.String
	SortByKey       optional.String
	SortByDirection optional.String
}

type ListExecutionsOpts ¶ 

type ListExecutionsOpts struct {
	IdName          optional.String
	Limit           optional.Int64
	Token           optional.String
	Filters         optional.String
	SortByKey       optional.String
	SortByDirection optional.String
}

type ListLaunchPlanIdsOpts ¶ 

type ListLaunchPlanIdsOpts struct {
	Limit           optional.Int64
	Token           optional.String
	SortByKey       optional.String
	SortByDirection optional.String
	Filters         optional.String
}

type ListLaunchPlans2Opts ¶ 

type ListLaunchPlans2Opts struct {
	IdName          optional.String
	Limit           optional.Int64
	Token           optional.String
	Filters         optional.String
	SortByKey       optional.String
	SortByDirection optional.String
}

type ListLaunchPlansOpts ¶ 

type ListLaunchPlansOpts struct {
	Limit           optional.Int64
	Token           optional.String
	Filters         optional.String
	SortByKey       optional.String
	SortByDirection optional.String
}

type ListMatchableAttributesOpts ¶ added in v0.18.15 

type ListMatchableAttributesOpts struct {
	ResourceType optional.String
}

type ListNamedEntitiesOpts ¶ added in v0.16.1 

type ListNamedEntitiesOpts struct {
	Limit           optional.Int64
	Token           optional.String
	SortByKey       optional.String
	SortByDirection optional.String
	Filters         optional.String
}

type ListNodeExecutionsForTaskOpts ¶ 

type ListNodeExecutionsForTaskOpts struct {
	TaskExecutionIdTaskIdResourceType optional.String
	Limit                             optional.Int64
	Token                             optional.String
	Filters                           optional.String
	SortByKey                         optional.String
	SortByDirection                   optional.String
}

type ListNodeExecutionsOpts ¶ 

type ListNodeExecutionsOpts struct {
	Limit           optional.Int64
	Token           optional.String
	Filters         optional.String
	SortByKey       optional.String
	SortByDirection optional.String
	UniqueParentId  optional.String
}

type ListProjectsOpts ¶ added in v0.18.15 

type ListProjectsOpts struct {
	Limit           optional.Int64
	Token           optional.String
	Filters         optional.String
	SortByKey       optional.String
	SortByDirection optional.String
}

type ListTaskExecutionsOpts ¶ 

type ListTaskExecutionsOpts struct {
	Limit           optional.Int64
	Token           optional.String
	Filters         optional.String
	SortByKey       optional.String
	SortByDirection optional.String
}

type ListTaskIdsOpts ¶ 

type ListTaskIdsOpts struct {
	Limit           optional.Int64
	Token           optional.String
	SortByKey       optional.String
	SortByDirection optional.String
	Filters         optional.String
}

type ListTasks2Opts ¶ 

type ListTasks2Opts struct {
	IdName          optional.String
	Limit           optional.Int64
	Token           optional.String
	Filters         optional.String
	SortByKey       optional.String
	SortByDirection optional.String
}

type ListTasksOpts ¶ 

type ListTasksOpts struct {
	Limit           optional.Int64
	Token           optional.String
	Filters         optional.String
	SortByKey       optional.String
	SortByDirection optional.String
}

type ListWorkflowIdsOpts ¶ 

type ListWorkflowIdsOpts struct {
	Limit           optional.Int64
	Token           optional.String
	SortByKey       optional.String
	SortByDirection optional.String
	Filters         optional.String
}

type ListWorkflows2Opts ¶ 

type ListWorkflows2Opts struct {
	IdName          optional.String
	Limit           optional.Int64
	Token           optional.String
	Filters         optional.String
	SortByKey       optional.String
	SortByDirection optional.String
}

type ListWorkflowsOpts ¶ 

type ListWorkflowsOpts struct {
	Limit           optional.Int64
	Token           optional.String
	Filters         optional.String
	SortByKey       optional.String
	SortByDirection optional.String
}

type PluginOverrideMissingPluginBehavior ¶ added in v0.18.15 

type PluginOverrideMissingPluginBehavior string

PluginOverrideMissingPluginBehavior : - FAIL: By default, if this plugin is not enabled for a Flyte deployment then execution will fail. - USE_DEFAULT: Uses the system-configured default implementation. 

const (
	PluginOverrideMissingPluginBehaviorFAIL        PluginOverrideMissingPluginBehavior = "FAIL"
	PluginOverrideMissingPluginBehaviorUSE_DEFAULT PluginOverrideMissingPluginBehavior = "USE_DEFAULT"
)

List of PluginOverrideMissingPluginBehavior

type ProjectProjectState ¶ added in v0.18.15 

type ProjectProjectState string

ProjectProjectState : The state of the project is used to control its visibility in the UI and validity. - ACTIVE: By default, all projects are considered active. - ARCHIVED: Archived projects are no longer visible in the UI and no longer valid. - SYSTEM_GENERATED: System generated projects that aren't explicitly created or managed by a user. 

const (
	ProjectProjectStateACTIVE           ProjectProjectState = "ACTIVE"
	ProjectProjectStateARCHIVED         ProjectProjectState = "ARCHIVED"
	ProjectProjectStateSYSTEM_GENERATED ProjectProjectState = "SYSTEM_GENERATED"
)

List of ProjectProjectState

type ProtobufListValue ¶ 

type ProtobufListValue struct {
	// Repeated field of dynamically typed values.
	Values []ProtobufValue `json:"values,omitempty"`
}

`ListValue` is a wrapper around a repeated field of values. The JSON representation for `ListValue` is JSON array.

type ProtobufNullValue ¶ 

type ProtobufNullValue string

ProtobufNullValue : `NullValue` is a singleton enumeration to represent the null value for the `Value` type union. The JSON representation for `NullValue` is JSON `null`. - NULL_VALUE: Null value. 

const (
	ProtobufNullValueNULL_VALUE ProtobufNullValue = "NULL_VALUE"
)

List of protobufNullValue

type ProtobufStruct ¶ 

type ProtobufStruct struct {
	// Unordered map of dynamically typed values.
	Fields map[string]ProtobufValue `json:"fields,omitempty"`
}

`Struct` represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, `Struct` might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language. The JSON representation for `Struct` is JSON object.

type ProtobufValue ¶ 

type ProtobufValue struct {
	// Represents a null value.
	NullValue *ProtobufNullValue `json:"null_value,omitempty"`
	// Represents a double value.
	NumberValue float64 `json:"number_value,omitempty"`
	// Represents a string value.
	StringValue string `json:"string_value,omitempty"`
	// Represents a boolean value.
	BoolValue bool `json:"bool_value,omitempty"`
	// Represents a structured value.
	StructValue *ProtobufStruct `json:"struct_value,omitempty"`
	// Represents a repeated `Value`.
	ListValue *ProtobufListValue `json:"list_value,omitempty"`
}

`Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of that variants, absence of any variant indicates an error. The JSON representation for `Value` is JSON value.

type QualityOfServiceTier ¶ added in v0.18.15 

type QualityOfServiceTier string

QualityOfServiceTier : - UNDEFINED: Default: no quality of service specified. 

const (
	QualityOfServiceTierUNDEFINED QualityOfServiceTier = "UNDEFINED"
	QualityOfServiceTierHIGH      QualityOfServiceTier = "HIGH"
	QualityOfServiceTierMEDIUM    QualityOfServiceTier = "MEDIUM"
	QualityOfServiceTierLOW       QualityOfServiceTier = "LOW"
)

List of QualityOfServiceTier

type ResourcesResourceEntry ¶ 

type ResourcesResourceEntry struct {
	// Resource name.
	Name  *ResourcesResourceName `json:"name,omitempty"`
	Value string                 `json:"value,omitempty"`
}

Encapsulates a resource name and value.

type ResourcesResourceName ¶ 

type ResourcesResourceName string

ResourcesResourceName : Known resource names. - EPHEMERAL_STORAGE: For Kubernetes-based deployments, pods use ephemeral local storage for scratch space, caching, and for logs. 

const (
	ResourcesResourceNameUNKNOWN           ResourcesResourceName = "UNKNOWN"
	ResourcesResourceNameCPU               ResourcesResourceName = "CPU"
	ResourcesResourceNameGPU               ResourcesResourceName = "GPU"
	ResourcesResourceNameMEMORY            ResourcesResourceName = "MEMORY"
	ResourcesResourceNameSTORAGE           ResourcesResourceName = "STORAGE"
	ResourcesResourceNameEPHEMERAL_STORAGE ResourcesResourceName = "EPHEMERAL_STORAGE"
)

List of ResourcesResourceName

type RuntimeMetadataRuntimeType ¶ 

type RuntimeMetadataRuntimeType string
const (
	RuntimeMetadataRuntimeTypeOTHER     RuntimeMetadataRuntimeType = "OTHER"
	RuntimeMetadataRuntimeTypeFLYTE_SDK RuntimeMetadataRuntimeType = "FLYTE_SDK"
)

List of RuntimeMetadataRuntimeType

type SchemaColumnSchemaColumnType ¶ 

type SchemaColumnSchemaColumnType string
const (
	SchemaColumnSchemaColumnTypeINTEGER  SchemaColumnSchemaColumnType = "INTEGER"
	SchemaColumnSchemaColumnTypeFLOAT    SchemaColumnSchemaColumnType = "FLOAT"
	SchemaColumnSchemaColumnTypeSTRING_  SchemaColumnSchemaColumnType = "STRING"
	SchemaColumnSchemaColumnTypeBOOLEAN  SchemaColumnSchemaColumnType = "BOOLEAN"
	SchemaColumnSchemaColumnTypeDATETIME SchemaColumnSchemaColumnType = "DATETIME"
	SchemaColumnSchemaColumnTypeDURATION SchemaColumnSchemaColumnType = "DURATION"
)

List of SchemaColumnSchemaColumnType

type SchemaTypeSchemaColumn ¶ 

type SchemaTypeSchemaColumn struct {
	Name string `json:"name,omitempty"`
	// The column type. This allows a limited set of types currently.
	Type_ *SchemaColumnSchemaColumnType `json:"type,omitempty"`
}

type SecretMountType ¶ added in v0.18.16 

type SecretMountType string

SecretMountType : - ANY: Default case, indicates the client can tolerate either mounting options. - ENV_VAR: ENV_VAR indicates the secret needs to be mounted as an environment variable. - FILE: FILE indicates the secret needs to be mounted as a file. 

const (
	SecretMountTypeANY     SecretMountType = "ANY"
	SecretMountTypeENV_VAR SecretMountType = "ENV_VAR"
	SecretMountTypeFILE    SecretMountType = "FILE"
)

List of SecretMountType

type SortDirection ¶ 

type SortDirection string

SortDirection : - DESCENDING: By default, fields are sorted in descending order. 

const (
	SortDirectionDESCENDING SortDirection = "DESCENDING"
	SortDirectionASCENDING  SortDirection = "ASCENDING"
)

List of SortDirection

type SqlDialect ¶ added in v0.20.1 

type SqlDialect string

SqlDialect : The dialect of the SQL statement. This is used to validate and parse SQL statements at compilation time to avoid expensive runtime operations. If set to an unsupported dialect, no validation will be done on the statement. We support the following dialect: ansi, hive. 

const (
	SqlDialectUNDEFINED SqlDialect = "UNDEFINED"
	SqlDialectANSI      SqlDialect = "ANSI"
	SqlDialectHIVE      SqlDialect = "HIVE"
	SqlDialectOTHER     SqlDialect = "OTHER"
)

List of SqlDialect

type StructuredDatasetTypeDatasetColumn ¶ added in v0.21.17 

type StructuredDatasetTypeDatasetColumn struct {
	// A unique name within the schema type for the column.
	Name string `json:"name,omitempty"`
	// The column type.
	LiteralType *CoreLiteralType `json:"literal_type,omitempty"`
}

type TaskExecutionMetadataInstanceClass ¶ added in v0.18.15 

type TaskExecutionMetadataInstanceClass string

TaskExecutionMetadataInstanceClass : Includes the broad category of machine used for this specific task execution. - DEFAULT: The default instance class configured for the flyte application platform. - INTERRUPTIBLE: The instance class configured for interruptible tasks. 

const (
	TaskExecutionMetadataInstanceClassDEFAULT_      TaskExecutionMetadataInstanceClass = "DEFAULT"
	TaskExecutionMetadataInstanceClassINTERRUPTIBLE TaskExecutionMetadataInstanceClass = "INTERRUPTIBLE"
)

List of TaskExecutionMetadataInstanceClass

type TaskLogMessageFormat ¶ 

type TaskLogMessageFormat string
const (
	TaskLogMessageFormatUNKNOWN TaskLogMessageFormat = "UNKNOWN"
	TaskLogMessageFormatCSV     TaskLogMessageFormat = "CSV"
	TaskLogMessageFormatJSON    TaskLogMessageFormat = "JSON"
)

List of TaskLogMessageFormat

type WorkflowMetadataOnFailurePolicy ¶ added in v0.18.15 

type WorkflowMetadataOnFailurePolicy string

WorkflowMetadataOnFailurePolicy : - FAIL_IMMEDIATELY: FAIL_IMMEDIATELY instructs the system to fail as soon as a node fails in the workflow. It'll automatically abort all currently running nodes and clean up resources before finally marking the workflow executions as failed. - FAIL_AFTER_EXECUTABLE_NODES_COMPLETE: FAIL_AFTER_EXECUTABLE_NODES_COMPLETE instructs the system to make as much progress as it can. The system will not alter the dependencies of the execution graph so any node that depend on the failed node will not be run. Other nodes that will be executed to completion before cleaning up resources and marking the workflow execution as failed. 

const (
	WorkflowMetadataOnFailurePolicyIMMEDIATELY                     WorkflowMetadataOnFailurePolicy = "FAIL_IMMEDIATELY"
	WorkflowMetadataOnFailurePolicyAFTER_EXECUTABLE_NODES_COMPLETE WorkflowMetadataOnFailurePolicy = "FAIL_AFTER_EXECUTABLE_NODES_COMPLETE"
)

List of WorkflowMetadataOnFailurePolicy

Source Files ¶

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.