pipelines

Documentation

Index

• Constants
• func DataSourcePipelines() common.Resource
• func ResourcePipeline() common.Resource
• type DeploymentKind
• type FileLibrary
• type NotebookLibrary
• type Notification
• type PipelineDeployment
• type PipelineHealthStatus
• type PipelineInfo
• type PipelineLibrary
• type PipelineListResponse
• type PipelineSpec
• type PipelineState
• type PipelineStateInfo
• type PipelineUpdateStateInfo
• type PipelinesAPI
  • func NewPipelinesAPI(ctx context.Context, m any) PipelinesAPI
  • func (a PipelinesAPI) Create(s PipelineSpec, timeout time.Duration) (string, error)
  • func (a PipelinesAPI) Delete(id string, timeout time.Duration) error
  • func (a PipelinesAPI) List(pageSize int, filter string) ([]PipelineStateInfo, error)
  • func (a PipelinesAPI) Read(id string) (p PipelineInfo, err error)
  • func (a PipelinesAPI) Update(id string, s PipelineSpec, timeout time.Duration) error

Constants

const DefaultTimeout = 20 * time.Minute

DefaultTimeout is the default amount of time that Terraform will wait when creating, updating and deleting pipelines.

Functions

func DataSourcePipelines

func DataSourcePipelines() common.Resource

func ResourcePipeline

func ResourcePipeline() common.Resource

ResourcePipeline defines the Terraform resource for pipelines.

Types

type DeploymentKind

type DeploymentKind string

const (
	DeploymentKindBundle DeploymentKind = "BUNDLE"
)

type FileLibrary

type FileLibrary struct {
	Path string `json:"path"`
}

type NotebookLibrary

type NotebookLibrary struct {
	Path string `json:"path"`
}

type Notification

type Notification struct {
	EmailRecipients []string `json:"email_recipients" tf:"min_items:1"`
	Alerts          []string `json:"alerts" tf:"min_items:1"`
}

type PipelineDeployment

type PipelineDeployment struct {
	Kind             DeploymentKind `json:"kind,omitempty"`
	MetadataFilePath string         `json:"metadata_file_path,omitempty"`
}

type PipelineHealthStatus

type PipelineHealthStatus string

PipelineHealthStatus ...

const (
	HealthStatusHealthy   PipelineHealthStatus = "HEALTHY"
	HealthStatusUnhealthy PipelineHealthStatus = "UNHEALTHY"
)

Constants for PipelineHealthStatus

type PipelineInfo

type PipelineInfo struct {
	PipelineID      string                `json:"pipeline_id"`
	Spec            *PipelineSpec         `json:"spec"`
	State           *PipelineState        `json:"state"`
	Cause           string                `json:"cause"`
	ClusterID       string                `json:"cluster_id"`
	Name            string                `json:"name"`
	Health          *PipelineHealthStatus `json:"health"`
	CreatorUserName string                `json:"creator_user_name"`
	LastModified    int64                 `json:"last_modified"`
}

type PipelineLibrary

type PipelineLibrary struct {
	Jar      string                `json:"jar,omitempty"`
	Maven    *compute.MavenLibrary `json:"maven,omitempty"`
	Whl      string                `json:"whl,omitempty"`
	Notebook *NotebookLibrary      `json:"notebook,omitempty"`
	File     *FileLibrary          `json:"file,omitempty"`
}

type PipelineListResponse

type PipelineListResponse struct {
	Statuses      []PipelineStateInfo `json:"statuses"`
	NextPageToken string              `json:"next_page_token,omitempty"`
	PrevPageToken string              `json:"prev_page_token,omitempty"`
}

type PipelineSpec

type PipelineSpec struct {
	ID                  string              `json:"id,omitempty" tf:"computed"`
	Name                string              `json:"name,omitempty"`
	Storage             string              `json:"storage,omitempty" tf:"force_new"`
	Catalog             string              `json:"catalog,omitempty" tf:"force_new"`
	Configuration       map[string]string   `json:"configuration,omitempty"`
	Clusters            []pipelineCluster   `json:"clusters,omitempty" tf:"alias:cluster"`
	Libraries           []PipelineLibrary   `json:"libraries,omitempty" tf:"slice_set,alias:library"`
	Filters             *filters            `json:"filters,omitempty"`
	Continuous          bool                `json:"continuous,omitempty"`
	Development         bool                `json:"development,omitempty"`
	AllowDuplicateNames bool                `json:"allow_duplicate_names,omitempty"`
	Target              string              `json:"target,omitempty"`
	Photon              bool                `json:"photon,omitempty"`
	Edition             string              `json:"edition,omitempty" tf:"suppress_diff,default:ADVANCED"`
	Channel             string              `json:"channel,omitempty" tf:"suppress_diff,default:CURRENT"`
	Notifications       []Notification      `json:"notifications,omitempty" tf:"alias:notification"`
	Serverless          bool                `json:"serverless" tf:"optional"`
	Deployment          *PipelineDeployment `json:"deployment,omitempty"`
}

type PipelineState

type PipelineState string

PipelineState ...

const (
	StateDeploying  PipelineState = "DEPLOYING"
	StateStarting   PipelineState = "STARTING"
	StateRunning    PipelineState = "RUNNING"
	StateStopping   PipelineState = "STOPPPING"
	StateDeleted    PipelineState = "DELETED"
	StateRecovering PipelineState = "RECOVERING"
	StateFailed     PipelineState = "FAILED"
	StateResetting  PipelineState = "RESETTING"
	StateIdle       PipelineState = "IDLE"
)

Constants for PipelineStates

type PipelineStateInfo

type PipelineStateInfo struct {
	PipelineID      string                    `json:"pipeline_id"`
	State           *PipelineState            `json:"state"`
	ClusterID       string                    `json:"cluster_id"`
	Name            string                    `json:"name"`
	Health          *PipelineHealthStatus     `json:"health"`
	CreatorUserName string                    `json:"creator_user_name"`
	RunAsUserName   string                    `json:"run_as_user_name"`
	LatestUpdates   []PipelineUpdateStateInfo `json:"latest_updates,omitempty"`
}

type PipelineUpdateStateInfo

type PipelineUpdateStateInfo struct {
	UpdateID     string         `json:"update_id"`
	State        *PipelineState `json:"state"`
	CreationTime string         `json:"creation_time"`
}

type PipelinesAPI

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

func NewPipelinesAPI

func NewPipelinesAPI(ctx context.Context, m any) PipelinesAPI

func (PipelinesAPI) Create

func (a PipelinesAPI) Create(s PipelineSpec, timeout time.Duration) (string, error)

func (PipelinesAPI) Delete

func (a PipelinesAPI) Delete(id string, timeout time.Duration) error

func (PipelinesAPI) List

func (a PipelinesAPI) List(pageSize int, filter string) ([]PipelineStateInfo, error)

List returns a list of the DLT pipelines. List could be filtered by name

func (PipelinesAPI) Read

func (a PipelinesAPI) Read(id string) (p PipelineInfo, err error)

func (PipelinesAPI) Update

func (a PipelinesAPI) Update(id string, s PipelineSpec, timeout time.Duration) error