flyteadmin

package
v0.4.20 Latest Latest
Warning

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

 Go to latest Published: Mar 12, 2020 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
AdminServiceApi CreateLaunchPlan Post /api/v1/launch_plans
AdminServiceApi CreateNodeEvent Post /api/v1/events/nodes
AdminServiceApi CreateTask Post /api/v1/tasks
AdminServiceApi CreateTaskEvent Post /api/v1/events/tasks
AdminServiceApi CreateWorkflow Post /api/v1/workflows
AdminServiceApi CreateWorkflowEvent Post /api/v1/events/workflows
AdminServiceApi DeleteProjectDomainAttributes Delete /api/v1/project_domain_attributes/{project}/{domain}
AdminServiceApi DeleteWorkflowAttributes Delete /api/v1/workflow_attributes/{project}/{domain}/{workflow}
AdminServiceApi GetActiveLaunchPlan Get /api/v1/active_launch_plans/{id.project}/{id.domain}/{id.name}
AdminServiceApi GetExecution Get /api/v1/executions/{id.project}/{id.domain}/{id.name}
AdminServiceApi GetExecutionData Get /api/v1/data/executions/{id.project}/{id.domain}/{id.name}
AdminServiceApi GetLaunchPlan Get /api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version}
AdminServiceApi GetNamedEntity Get /api/v1/named_entities/{resource_type}/{id.project}/{id.domain}/{id.name}
AdminServiceApi GetNodeExecution Get /api/v1/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}
AdminServiceApi GetNodeExecutionData Get /api/v1/data/node_executions/{id.execution_id.project}/{id.execution_id.domain}/{id.execution_id.name}/{id.node_id}
AdminServiceApi GetProjectDomainAttributes Get /api/v1/project_domain_attributes/{project}/{domain}
AdminServiceApi GetTask Get /api/v1/tasks/{id.project}/{id.domain}/{id.name}/{id.version}
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}
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}
AdminServiceApi GetWorkflow Get /api/v1/workflows/{id.project}/{id.domain}/{id.name}/{id.version}
AdminServiceApi GetWorkflowAttributes Get /api/v1/workflow_attributes/{project}/{domain}/{workflow}
AdminServiceApi ListActiveLaunchPlans Get /api/v1/active_launch_plans/{project}/{domain}
AdminServiceApi ListExecutions Get /api/v1/executions/{id.project}/{id.domain}
AdminServiceApi ListLaunchPlanIds Get /api/v1/launch_plan_ids/{project}/{domain}
AdminServiceApi ListLaunchPlans Get /api/v1/launch_plans/{id.project}/{id.domain}/{id.name}
AdminServiceApi ListLaunchPlans2 Get /api/v1/launch_plans/{id.project}/{id.domain}
AdminServiceApi ListMatchableAttributes Get /api/v1/matchable_attributes
AdminServiceApi ListNamedEntities Get /api/v1/named_entities/{resource_type}/{project}/{domain}
AdminServiceApi ListNodeExecutions Get /api/v1/node_executions/{workflow_execution_id.project}/{workflow_execution_id.domain}/{workflow_execution_id.name}
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}
AdminServiceApi ListProjects Get /api/v1/projects
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}
AdminServiceApi ListTaskIds Get /api/v1/task_ids/{project}/{domain}
AdminServiceApi ListTasks Get /api/v1/tasks/{id.project}/{id.domain}/{id.name}
AdminServiceApi ListTasks2 Get /api/v1/tasks/{id.project}/{id.domain}
AdminServiceApi ListWorkflowIds Get /api/v1/workflow_ids/{project}/{domain}
AdminServiceApi ListWorkflows Get /api/v1/workflows/{id.project}/{id.domain}/{id.name}
AdminServiceApi ListWorkflows2 Get /api/v1/workflows/{id.project}/{id.domain}
AdminServiceApi RegisterProject Post /api/v1/projects
AdminServiceApi RelaunchExecution Post /api/v1/executions/relaunch
AdminServiceApi TerminateExecution Delete /api/v1/executions/{id.project}/{id.domain}/{id.name}
AdminServiceApi UpdateLaunchPlan Put /api/v1/launch_plans/{id.project}/{id.domain}/{id.name}/{id.version}
AdminServiceApi UpdateNamedEntity Put /api/v1/named_entities/{resource_type}/{id.project}/{id.domain}/{id.name}
AdminServiceApi UpdateProjectDomainAttributes Put /api/v1/project_domain_attributes/{attributes.project}/{attributes.domain}
AdminServiceApi UpdateWorkflowAttributes Put /api/v1/workflow_attributes/{attributes.project}/{attributes.domain}/{attributes.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.4.20 

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"`
}

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 {
	AssumableIamRole         string `json:"assumable_iam_role,omitempty"`
	KubernetesServiceAccount string `json:"kubernetes_service_account,omitempty"`
}

Defines permissions associated with executions created by this launch plan spec.

type AdminClusterResourceAttributes added in v0.4.20 

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 AdminDomain 

type AdminDomain struct {
	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 {
	// The list of email addresses recipients for this notification.
	RecipientsEmail []string `json:"recipients_email,omitempty"`
}

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 {
	// A map of outputs in the case of a successful execution.
	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"`
	ComputedInputs *CoreLiteralMap     `json:"computed_inputs,omitempty"`
	// Most recent recorded phase for the execution.
	Phase *CoreWorkflowExecutionPhase `json:"phase,omitempty"`
	// Reported ime 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"`
}

type AdminExecutionClusterLabel added in v0.4.20 

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

type AdminExecutionCreateRequest 

type AdminExecutionCreateRequest struct {
	// Name of the project the execution belongs to.
	Project string `json:"project,omitempty"`
	// Name of the domain the execution belongs to.  A domain can be considered as a subset within a specific project.
	Domain string `json:"domain,omitempty"`
	Name   string `json:"name,omitempty"`
	// Additional fields necessary to launch the execution.
	Spec *AdminExecutionSpec `json:"spec,omitempty"`
	// The inputs required to start the execution. All required inputs must be included in this map. If not required and not provided, defaults apply.
	Inputs *CoreLiteralMap `json:"inputs,omitempty"`
}

Request to launch an execution with the given project, domain and optionally 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"`
}

Used as a response for request to list executions.

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.4.20 

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

type AdminExecutionRelaunchRequest 

type AdminExecutionRelaunchRequest struct {
	// Identifier of the workflow execution to relaunch.
	Id   *CoreWorkflowExecutionIdentifier `json:"id,omitempty"`
	Name string                           `json:"name,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"`
}

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 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 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 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 {
	Id      *CoreIdentifier         `json:"id,omitempty"`
	Spec    *AdminLaunchPlanSpec    `json:"spec,omitempty"`
	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 {
	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. A LaunchPlanSpec may include 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 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"`
}

Response object for list launch plan requests.

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"`
	DefaultInputs  *CoreParameterMap        `json:"default_inputs,omitempty"`
	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"`
}

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.
	Id *CoreIdentifier `json:"id,omitempty"`
	// Desired state to apply to the launch plan.
	State *AdminLaunchPlanState `json:"state,omitempty"`
}

Request to set the referenced launch plan state to the configured value.

type AdminLaunchPlanUpdateResponse 

type AdminLaunchPlanUpdateResponse struct {
}

Purposefully empty, may be populated in the future.

type AdminListMatchableAttributesResponse added in v0.4.20 

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

Response for a request for all matching resource attributes.

type AdminLiteralMapBlob 

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

type AdminMatchableAttributesConfiguration added in v0.4.20 

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.

type AdminMatchableResource added in v0.4.20 

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 

const (
	AdminMatchableResourceTASK_RESOURCE           AdminMatchableResource = "TASK_RESOURCE"
	AdminMatchableResourceCLUSTER_RESOURCE        AdminMatchableResource = "CLUSTER_RESOURCE"
	AdminMatchableResourceEXECUTION_QUEUE         AdminMatchableResource = "EXECUTION_QUEUE"
	AdminMatchableResourceEXECUTION_CLUSTER_LABEL AdminMatchableResource = "EXECUTION_CLUSTER_LABEL"
)

List of adminMatchableResource

type AdminMatchingAttributes added in v0.4.20 

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"`
}

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

type AdminNamedEntity added in v0.4.20 

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

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 resource can internally have multiple versions.

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.4.20 

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.4.20 

type AdminNamedEntityMetadata struct {
	Description string `json:"description,omitempty"`
}

type AdminNamedEntityUpdateRequest added in v0.4.20 

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

Request to set the referenced launch plan state to the configured value.

type AdminNamedEntityUpdateResponse added in v0.4.20 

type AdminNamedEntityUpdateResponse struct {
}

Purposefully empty, may be populated in the future.

type AdminNodeExecutionClosure 

type AdminNodeExecutionClosure struct {
	OutputUri string              `json:"output_uri,omitempty"`
	Error_    *CoreExecutionError `json:"error,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"`
}

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.
	Inputs *AdminUrlBlob `json:"inputs,omitempty"`
	// Signed url to fetch a core.LiteralMap of node execution outputs.
	Outputs *AdminUrlBlob `json:"outputs,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"`
}

Request structure to retrieve a list of node execution entities.

type AdminNodeExecutionMetaData added in v0.4.20 

type AdminNodeExecutionMetaData struct {
}

type AdminNotification 

type AdminNotification struct {
	// A list of phases to which users can associate the notifications to.
	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 Admin. Future iterations could expose configuring notifications with custom content.

type AdminNotificationList 

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

type AdminPagerDutyNotification 

type AdminPagerDutyNotification struct {
	// Currently, PagerDuty notifications leverage email to trigger a notification.
	RecipientsEmail []string `json:"recipients_email,omitempty"`
}

type AdminProject 

type AdminProject struct {
	Id string `json:"id,omitempty"`
	// Display name.
	Name        string        `json:"name,omitempty"`
	Domains     []AdminDomain `json:"domains,omitempty"`
	Description string        `json:"description,omitempty"`
}

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

type AdminProjectDomainAttributes added in v0.4.20 

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.4.20 

type AdminProjectDomainAttributesDeleteRequest struct {
	// Unique project id which this set of attributes references.
	Project string `json:"project,omitempty"`
	// Unique domain id which this set of attributes references.
	Domain       string                  `json:"domain,omitempty"`
	ResourceType *AdminMatchableResource `json:"resource_type,omitempty"`
}

type AdminProjectDomainAttributesDeleteResponse added in v0.4.20 

type AdminProjectDomainAttributesDeleteResponse struct {
}

Purposefully empty, may be populated in the future.

type AdminProjectDomainAttributesGetResponse added in v0.4.20 

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

type AdminProjectDomainAttributesUpdateRequest added in v0.4.20 

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

Sets custom attributes for a project-domain combination.

type AdminProjectDomainAttributesUpdateResponse added in v0.4.20 

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 {
}

type AdminProjects 

type AdminProjects struct {
	Projects []AdminProject `json:"projects,omitempty"`
}

type AdminSchedule 

type AdminSchedule struct {
	CronExpression string          `json:"cron_expression,omitempty"`
	Rate           *AdminFixedRate `json:"rate,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 Create a workflow 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 register a launch plan 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 Create a node execution event recording a phase transition.

  • @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 AdminTaskCreateRequest) (AdminTaskCreateResponse, *http.Response, error)

AdminServiceApiService Create and register a task definition.

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

@return AdminTaskCreateResponse

func (*AdminServiceApiService) CreateTaskEvent 

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

AdminServiceApiService Create a task execution event recording a phase transition.

  • @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 register a 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 Create a workflow execution event recording a phase transition.

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

@return AdminWorkflowExecutionEventResponse

func (*AdminServiceApiService) DeleteProjectDomainAttributes added in v0.4.20 

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

AdminServiceApiService Delete the customized resource attributes associated with a project-domain combination

  • @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.
  • @param domain Unique domain id which this set of attributes references.
  • @param body

@return AdminProjectDomainAttributesDeleteResponse

func (*AdminServiceApiService) DeleteWorkflowAttributes added in v0.4.20 

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

AdminServiceApiService Delete the customized resource attributes associated with a project, domain and workflow combination

  • @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.
  • @param domain Unique domain id which this set of attributes references.
  • @param workflow Workflow name which this set of attributes references.
  • @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 Retrieve the active launch plan version specified by input request filters.

  • @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) GetExecution 

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

AdminServiceApiService Retrieve an existing workflow 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 Retrieve input and output data from an existing workflow 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) 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.4.20 

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

AdminServiceApiService Retrieve a NamedEntity object.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param resourceType
  • @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 Retrieve an existing node execution.

  • @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 Retrieve input and output data from an existing node execution.

  • @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) GetProjectDomainAttributes added in v0.4.20 

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) 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.4.20 

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) 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.4.20 

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

func (*AdminServiceApiService) ListNamedEntities added in v0.4.20 

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) (AdminProjects, *http.Response, error)

AdminServiceApiService Fetch registered projects.

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

@return AdminProjects

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

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

AdminServiceApiService Register a project.

  • @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 Relaunch a workflow 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 Terminate the active workflow execution specified in the request.

  • @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) UpdateLaunchPlan 

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

AdminServiceApiService Update the status of an existing launch plan definition. At most one launch plan version for a given {project, domain, name} can be active at a time. If this call sets a launch plan to active and existing version is already active, the result of this call will be that the formerly active launch plan will be made inactive and specified launch plan in this request will be made active. In the event that the formerly active launch plan had a schedule associated it with it, this schedule will be disabled. If the reference launch plan in this request is being set to active and has a schedule associated with it, the schedule will be enabled.

  • @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.4.20 

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

AdminServiceApiService Update the fields associated with a NamedEntity

  • @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
  • @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) UpdateProjectDomainAttributes added in v0.4.20 

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

AdminServiceApiService Update the customized resource attributes associated with a project-domain combination

  • @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.4.20 

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

AdminServiceApiService Update the customized resource attributes associated with a project, domain and workflow combination

  • @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 {
	// Currently, Slack notifications leverage email to trigger a notification.
	RecipientsEmail []string `json:"recipients_email,omitempty"`
}

type AdminSort 

type AdminSort struct {
	// Indicates an attribute to sort the response values. TODO(katrogan): Add string validation here. This should never be empty.
	Key       string         `json:"key,omitempty"`
	Direction *SortDirection `json:"direction,omitempty"`
}

Species sort ordering in a list request.

type AdminSystemMetadata added in v0.4.20 

type AdminSystemMetadata struct {
	// Which execution cluster this execution ran on.
	ExecutionCluster string `json:"execution_cluster,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"`
}

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 AdminTaskCreateRequest 

type AdminTaskCreateRequest struct {
	// id represents the unique identifier of the task.
	Id *CoreIdentifier `json:"id,omitempty"`
	// Represents the specification for task.
	Spec *AdminTaskSpec `json:"spec,omitempty"`
}

Represents a request structure to create a revision of a task.

type AdminTaskCreateResponse 

type AdminTaskCreateResponse struct {
}

Represents a response structure if task creation succeeds.

type AdminTaskExecutionClosure 

type AdminTaskExecutionClosure struct {
	// Path to remote data store where output blob is stored if the execution succeeded (and produced outputs).
	OutputUri string `json:"output_uri,omitempty"`
	// Error information for the task execution. Populated if the execution failed.
	Error_ *CoreExecutionError `json:"error,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"`
}

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.
	Inputs *AdminUrlBlob `json:"inputs,omitempty"`
	// Signed url to fetch a core.LiteralMap of task execution outputs.
	Outputs *AdminUrlBlob `json:"outputs,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"`
}

Response structure for a query to list of task execution entities.

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"`
}

Represents a list of tasks returned from the admin.

type AdminTaskResourceAttributes added in v0.4.20 

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

type AdminTaskResourceSpec added in v0.4.20 

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

type AdminTaskSpec 

type AdminTaskSpec struct {
	// Template of the task that encapsulates all the metadata of the task.
	Template *CoreTaskTemplate `json:"template,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 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"`
}

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.4.20 

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.4.20 

type AdminWorkflowAttributesDeleteRequest struct {
	// Unique project id which this set of attributes references.
	Project string `json:"project,omitempty"`
	// Unique domain id which this set of attributes references.
	Domain string `json:"domain,omitempty"`
	// Workflow name which this set of attributes references.
	Workflow     string                  `json:"workflow,omitempty"`
	ResourceType *AdminMatchableResource `json:"resource_type,omitempty"`
}

type AdminWorkflowAttributesDeleteResponse added in v0.4.20 

type AdminWorkflowAttributesDeleteResponse struct {
}

Purposefully empty, may be populated in the future.

type AdminWorkflowAttributesGetResponse added in v0.4.20 

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

type AdminWorkflowAttributesUpdateRequest added in v0.4.20 

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

Sets custom attributes for a project, domain and workflow combination.

type AdminWorkflowAttributesUpdateResponse added in v0.4.20 

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 represents the unique identifier of the workflow.
	Id *CoreIdentifier `json:"id,omitempty"`
	// Represents the specification for workflow.
	Spec *AdminWorkflowSpec `json:"spec,omitempty"`
}

Represents a request structure to create a revision of a workflow.

type AdminWorkflowCreateResponse 

type AdminWorkflowCreateResponse struct {
}

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.
	Outputs *AdminUrlBlob `json:"outputs,omitempty"`
	// Signed url to fetch a core.LiteralMap of execution inputs.
	Inputs *AdminUrlBlob `json:"inputs,omitempty"`
}

Response structure for WorkflowExecutionGetDataRequest which contains inputs and outputs for an 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"`
}

Represents a list of workflows returned from the admin.

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 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 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 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 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"`
}

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, primtives).

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.
	Config []CoreKeyValuePair  `json:"config,omitempty"`
	Ports  []CoreContainerPort `json:"ports,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 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 CoreIdentifier 

type CoreIdentifier struct {
	// Identifies the specific type of resource that this identifer 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 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 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"`
}

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"`
	// 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"`
}

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 fullfilled.
	Inputs []CoreBinding `json:"inputs,omitempty"`
	// +optional Specifies execution depdendency for this node ensuring it will only get scheduled to run after all its upstream nodes have completed. This node will have an implicit depdendency 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"`
}

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

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 CoreOperand 

type CoreOperand struct {
	Primitive *CorePrimitive `json:"primitive,omitempty"`
	Var_      string         `json:"var,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"`
}

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 CoreResourceType 

type CoreResourceType string

CoreResourceType : Indicates a resource type within Flyte. 

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

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 interpretted 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 losely 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    *FlyteidlcoreSchema `json:"schema,omitempty"`
	NoneType  *CoreVoid           `json:"none_type,omitempty"`
	Error_    *CoreError          `json:"error,omitempty"`
	Generic   *ProtobufStruct     `json:"generic,omitempty"`
}

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

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"`
}

type CoreTaskNode 

type CoreTaskNode struct {
	// A globally unique identifier for the task.
	ReferenceId *CoreIdentifier `json:"reference_id,omitempty"`
}

Refers to the task that the Node is to execute.

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 gauarantees 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"`
}

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

type CoreTypedInterface 

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

Defines strongly typed inputs and outputs.

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

List of coreWorkflowExecutionPhase

type CoreWorkflowMetadata 

type CoreWorkflowMetadata struct {
}

Metadata for the entire workflow. To be used in the future.

type CoreWorkflowMetadataDefaults added in v0.4.20 

type CoreWorkflowMetadataDefaults struct {
	// Identify whether workflow is interruptible. The value set at the workflow level will be the defualt value used for nodes unless explicitly set at the node level.
	Interruptible bool `json:"interruptible,omitempty"`
}

Default Workflow Metadata for the entire workflow.

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 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"`
	// 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"`
	WorkflowNodeMetadata *FlyteidleventWorkflowNodeMetadata `json:"workflow_node_metadata,omitempty"`
	// Specifies which task (if any) launched this node.
	ParentTaskMetadata *EventParentTaskExecutionMetadata `json:"parent_task_metadata,omitempty"`
}

type EventParentTaskExecutionMetadata 

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

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"`
	// 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"`
	// 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"`
}

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"`
}

type ExecutionErrorErrorKind added in v0.4.20 

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. 

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

List of ExecutionMetadataExecutionMode

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 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 FlyteidladminWorkflowNodeMetadata 

type FlyteidladminWorkflowNodeMetadata struct {
	ExecutionId *CoreWorkflowExecutionIdentifier `json:"executionId,omitempty"`
}

type FlyteidlcoreSchema 

type FlyteidlcoreSchema 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 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 GetLaunchPlanOpts 

type GetLaunchPlanOpts struct {
	IdResourceType optional.String
}

type GetProjectDomainAttributesOpts added in v0.4.20 

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.4.20 

type GetWorkflowAttributesOpts struct {
	ResourceType optional.String
}

type GetWorkflowOpts 

type GetWorkflowOpts struct {
	IdResourceType optional.String
}

type ListActiveLaunchPlansOpts added in v0.1.1 

type ListActiveLaunchPlansOpts struct {
	Limit           optional.Int64
	Token           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
}

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.4.20 

type ListMatchableAttributesOpts struct {
	ResourceType optional.String
}

type ListNamedEntitiesOpts added in v0.4.20 

type ListNamedEntitiesOpts struct {
	Limit           optional.Int64
	Token           optional.String
	SortByKey       optional.String
	SortByDirection 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
}

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
}

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
}

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 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 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. 

const (
	ResourcesResourceNameUNKNOWN ResourcesResourceName = "UNKNOWN"
	ResourcesResourceNameCPU     ResourcesResourceName = "CPU"
	ResourcesResourceNameGPU     ResourcesResourceName = "GPU"
	ResourcesResourceNameMEMORY  ResourcesResourceName = "MEMORY"
	ResourcesResourceNameSTORAGE ResourcesResourceName = "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 SortDirection 

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

List of SortDirection

type TaskLogMessageFormat 

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

List of TaskLogMessageFormat

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.