client

package
v0.11.2 Latest Latest
Warning

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

Go to latest
Published: Apr 22, 2024 License: MPL-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ComputeEnvAWSBatchConfig

type ComputeEnvAWSBatchConfig struct {
	Region       string `json:"region"`
	ComputeQueue string `json:"computeQueue"`
	HeadQueue    string `json:"headQueue"`
	CliPath      string `json:"cliPath"`
	WorkDir      string `json:"workDir"`

	ExecutionRole  string `json:"executionRole,omitempty"`
	HeadJobRole    string `json:"headJobRole,omitempty"`
	ComputeJobRole string `json:"computeJobRole,omitempty"`

	PreRunScript    string                    `json:"preRunScript,omitempty"`
	PostRunScript   string                    `json:"postRunScript,omitempty"`
	HeadJobCpus     int                       `json:"headJobCpus"`
	HeadJobMemoryMb int                       `json:"headJobMemoryMb"`
	Environment     []*ComputeEnvConfigEnvVar `json:"environment,omitempty"`
}

type ComputeEnvConfigEnvVar

type ComputeEnvConfigEnvVar struct {
	Name    string `json:"name"`
	Value   string `json:"value"`
	Head    bool   `json:"head"`
	Compute bool   `json:"compute"`
}

type ComputeEnvLSFPlatformConfig added in v0.9.0

type ComputeEnvLSFPlatformConfig struct {
	WorkDir                 string `json:"workDir"`
	LaunchDir               string `json:"launchDir"`
	UserName                string `json:"userName"`
	HostName                string `json:"hostName"`
	HeadQueue               string `json:"headQueue"`
	ComputeQueue            string `json:"computeQueue"`
	HeadJobOptions          string `json:"headJobOptions"`
	PropagateHeadJobOptions bool   `json:"propagateHeadJobOptions"`
	PerJobMemLimit          bool   `json:"perJobMemLimit"`
	PerTaskReserve          bool   `json:"perTaskReserve"`

	Port          int                       `json:"port,omitempty"`
	MaxQueueSize  int                       `json:"maxQueueSize,omitempty"`
	PreRunScript  string                    `json:"preRunScript,omitempty"`
	PostRunScript string                    `json:"postRunScript,omitempty"`
	UnitForLimits string                    `json:"unitForLimits,omitempty"`
	Environment   []*ComputeEnvConfigEnvVar `json:"environment,omitempty"`
}

type TowerClient

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

func NewTowerClient

func NewTowerClient(ctx context.Context, userAgent string, apiKey string, apiUrl string, org string) (*TowerClient, error)

func (*TowerClient) CreateAWSBatchComputeEnv

func (c *TowerClient) CreateAWSBatchComputeEnv(
	ctx context.Context,
	workspaceId string,
	name string,
	description string,
	credentialsId string,
	config *ComputeEnvAWSBatchConfig) (string, error)

func (*TowerClient) CreateAction added in v0.5.0

func (c *TowerClient) CreateAction(
	ctx context.Context,
	workspaceId string,
	name string,
	source string,
	computeEnvironmentId string,
	pipeline string,
	workDir string,
	revision string,
	preRunScript string,
	postRunScript string,
	configProfiles []interface{},
	pipelineParameters string,
	nextflowConfig string,
	towerConfig string,
	mainScript string,
	workflowEntryName string,
	schemaName string,
	workspaceSecrets []interface{},
	labels []string) (string, error)

func (*TowerClient) CreateCredentialsAWS

func (c *TowerClient) CreateCredentialsAWS(
	ctx context.Context,
	workspaceId string,
	name string,
	description string,
	accessKey string,
	secretKey string,
	assumeRoleArn string) (string, error)

func (*TowerClient) CreateCredentialsContainerRegistry added in v0.11.0

func (c *TowerClient) CreateCredentialsContainerRegistry(
	ctx context.Context,
	workspaceId string,
	name string,
	description string,
	username string,
	password string,
	registryServer string) (string, error)

func (*TowerClient) CreateCredentialsGithub

func (c *TowerClient) CreateCredentialsGithub(
	ctx context.Context,
	workspaceId string,
	name string,
	description string,
	baseUrl string,
	username string,
	accessToken string) (string, error)

func (*TowerClient) CreateCredentialsGitlab added in v0.10.0

func (c *TowerClient) CreateCredentialsGitlab(
	ctx context.Context,
	workspaceId string,
	name string,
	description string,
	baseUrl string,
	username string,
	password string,
	token string) (string, error)

func (*TowerClient) CreateCredentialsSSH added in v0.10.0

func (c *TowerClient) CreateCredentialsSSH(
	ctx context.Context,
	workspaceId string,
	name string,
	description string,
	sshKey string,
	sshKeyPassphrase string) (string, error)

func (*TowerClient) CreateDataset added in v0.5.0

func (c *TowerClient) CreateDataset(ctx context.Context, workspaceId string, name string, description string) (string, error)

func (*TowerClient) CreateDatasetVersion added in v0.5.0

func (c *TowerClient) CreateDatasetVersion(ctx context.Context, workspaceId string, datasetId string, fileContents string, filename string, hasHeader bool) (int, error)

func (*TowerClient) CreateLSFPlatformComputeEnv added in v0.9.0

func (c *TowerClient) CreateLSFPlatformComputeEnv(
	ctx context.Context,
	workspaceId string,
	name string,
	description string,
	credentialsId string,
	config *ComputeEnvLSFPlatformConfig) (string, error)

func (*TowerClient) CreateOrganizationMember added in v0.2.0

func (c *TowerClient) CreateOrganizationMember(ctx context.Context, email string, role string) (int64, error)

func (*TowerClient) CreatePipeline added in v0.6.0

func (c *TowerClient) CreatePipeline(
	ctx context.Context,
	workspaceId string,
	name string,
	description string,
	computeEnvironmentId string,
	pipeline string,
	workDir string,
	revision string,
	preRunScript string,
	postRunScript string,
	configProfiles []interface{},
	pipelineParameters string,
	nextflowConfig string,
	towerConfig string,
	mainScript string,
	workflowEntryName string,
	schemaName string,
	workspaceSecrets []interface{},
	labels []string) (int64, error)

func (*TowerClient) CreatePipelineSecrets added in v0.9.0

func (c *TowerClient) CreatePipelineSecrets(
	ctx context.Context,
	workspaceId string,
	name string,
	value string) (string, error)

func (*TowerClient) CreateToken added in v0.5.0

func (c *TowerClient) CreateToken(ctx context.Context, name string) (string, string, error)

func (*TowerClient) CreateWorkspace

func (c *TowerClient) CreateWorkspace(ctx context.Context, name string, fullName string, description string, visibility string) (int64, error)

func (*TowerClient) CreateWorkspaceParticipant added in v0.2.0

func (c *TowerClient) CreateWorkspaceParticipant(ctx context.Context, workspaceId string, memberId int64, role string) (int64, string, error)

func (*TowerClient) DeleteAction added in v0.5.0

func (c *TowerClient) DeleteAction(ctx context.Context, workspaceId string, id string) error

func (*TowerClient) DeleteComputeEnv

func (c *TowerClient) DeleteComputeEnv(ctx context.Context, workspaceId string, id string) error

func (*TowerClient) DeleteCredentials

func (c *TowerClient) DeleteCredentials(ctx context.Context, workspaceId string, id string) error

func (*TowerClient) DeleteDataset added in v0.5.0

func (c *TowerClient) DeleteDataset(ctx context.Context, workspaceId string, id string) error

func (*TowerClient) DeleteOrganizationMember added in v0.2.0

func (c *TowerClient) DeleteOrganizationMember(ctx context.Context, id int64) error

func (*TowerClient) DeletePipeline added in v0.6.0

func (c *TowerClient) DeletePipeline(ctx context.Context, workspaceId string, id string) error

func (*TowerClient) DeletePipelineSecrets added in v0.9.0

func (c *TowerClient) DeletePipelineSecrets(ctx context.Context, workspaceId string, id string) error

func (*TowerClient) DeleteToken added in v0.5.0

func (c *TowerClient) DeleteToken(ctx context.Context, id string) error

func (*TowerClient) DeleteWorkspace

func (c *TowerClient) DeleteWorkspace(ctx context.Context, id int64) error

func (*TowerClient) DeleteWorkspaceParticipant added in v0.2.0

func (c *TowerClient) DeleteWorkspaceParticipant(ctx context.Context, workspaceId string, id int64) error

func (*TowerClient) GetAction added in v0.5.0

func (c *TowerClient) GetAction(ctx context.Context, workspaceId string, id string) (map[string]interface{}, error)

func (*TowerClient) GetComputeEnv

func (c *TowerClient) GetComputeEnv(ctx context.Context, workspaceId string, id string) (map[string]interface{}, error)

func (*TowerClient) GetComputeEnvByName

func (c *TowerClient) GetComputeEnvByName(ctx context.Context, workspaceId string, name string) (map[string]interface{}, error)

func (*TowerClient) GetCredentials

func (c *TowerClient) GetCredentials(ctx context.Context, workspaceId string, id string) (map[string]interface{}, error)

func (*TowerClient) GetCredentialsByName

func (c *TowerClient) GetCredentialsByName(ctx context.Context, workspaceId string, name string) (map[string]interface{}, error)

func (*TowerClient) GetDataset added in v0.5.0

func (c *TowerClient) GetDataset(ctx context.Context, workspaceId string, id string) (map[string]interface{}, error)

func (*TowerClient) GetDatasetVersion added in v0.5.0

func (c *TowerClient) GetDatasetVersion(ctx context.Context, workspaceId string, datasetId string, versionId int) (map[string]interface{}, error)

func (*TowerClient) GetOrganizationMember added in v0.2.0

func (c *TowerClient) GetOrganizationMember(ctx context.Context, email string) (map[string]interface{}, error)

func (*TowerClient) GetPipeline added in v0.6.0

func (c *TowerClient) GetPipeline(ctx context.Context, workspaceId string, id string) (map[string]interface{}, error)

func (*TowerClient) GetPipelineByName added in v0.6.0

func (c *TowerClient) GetPipelineByName(ctx context.Context, workspaceId string, name string) (map[string]interface{}, error)

func (*TowerClient) GetPipelineSecret added in v0.9.0

func (c *TowerClient) GetPipelineSecret(ctx context.Context, workspaceId string, id string) (map[string]interface{}, error)

func (*TowerClient) GetPipelineSecretByName added in v0.9.0

func (c *TowerClient) GetPipelineSecretByName(ctx context.Context, workspaceId string, name string) (map[string]interface{}, error)

func (*TowerClient) GetToken added in v0.5.0

func (c *TowerClient) GetToken(ctx context.Context, id string) (map[string]interface{}, error)

func (*TowerClient) GetWorkspace

func (c *TowerClient) GetWorkspace(ctx context.Context, id int64) (map[string]interface{}, error)

func (*TowerClient) GetWorkspaceByName

func (c *TowerClient) GetWorkspaceByName(ctx context.Context, name string) (map[string]interface{}, error)

func (*TowerClient) GetWorkspaceParticipantByMemberEmail added in v0.8.0

func (c *TowerClient) GetWorkspaceParticipantByMemberEmail(ctx context.Context, workspaceId string, email string) (map[string]interface{}, error)

func (*TowerClient) GetWorkspaceParticipantByMemberId added in v0.8.0

func (c *TowerClient) GetWorkspaceParticipantByMemberId(ctx context.Context, workspaceId string, memberId int64) (map[string]interface{}, error)

func (*TowerClient) GetWorkspaceParticipants added in v0.8.0

func (c *TowerClient) GetWorkspaceParticipants(ctx context.Context, workspaceId string, search map[string]string) ([]interface{}, error)

func (*TowerClient) UpdateAction added in v0.5.0

func (c *TowerClient) UpdateAction(
	ctx context.Context,
	workspaceId string,
	id string,
	pipeline string,
	launchId string,
	computeEnvironmentId string,
	workDir string,
	revision string,
	preRunScript string,
	postRunScript string,
	configProfiles []interface{},
	pipelineParameters string,
	nextflowConfig string,
	towerConfig string,
	mainScript string,
	workflowEntryName string,
	schemaName string,
	workspaceSecrets []interface{},
	labels []string) error

func (*TowerClient) UpdateCredentialsAWS

func (c *TowerClient) UpdateCredentialsAWS(
	ctx context.Context,
	id string,
	workspaceId string,
	description string,
	accessKey string,
	secretKey string,
	assumeRoleArn string) error

func (*TowerClient) UpdateCredentialsContainerRegistry added in v0.11.0

func (c *TowerClient) UpdateCredentialsContainerRegistry(
	ctx context.Context,
	workspaceId string,
	id string,
	description string,
	username string,
	password string,
	registryServer string) error

func (*TowerClient) UpdateCredentialsGithub

func (c *TowerClient) UpdateCredentialsGithub(
	ctx context.Context,
	id string,
	workspaceId string,
	description string,
	baseUrl string,
	username string,
	accessToken string) error

func (*TowerClient) UpdateDataset added in v0.5.0

func (c *TowerClient) UpdateDataset(ctx context.Context, workspaceId string, id string, name string, description string) error

func (*TowerClient) UpdateOrganizationMemberRole added in v0.2.0

func (c *TowerClient) UpdateOrganizationMemberRole(ctx context.Context, id int64, role string) error

func (*TowerClient) UpdatePipeline added in v0.6.0

func (c *TowerClient) UpdatePipeline(
	ctx context.Context,
	workspaceId string,
	id string,
	description string,
	computeEnvironmentId string,
	pipeline string,
	workDir string,
	revision string,
	preRunScript string,
	postRunScript string,
	configProfiles []interface{},
	pipelineParameters string,
	nextflowConfig string,
	towerConfig string,
	mainScript string,
	workflowEntryName string,
	schemaName string,
	workspaceSecrets []interface{},
	labels []string) error

func (*TowerClient) UpdatePipelineSecrets added in v0.9.0

func (c *TowerClient) UpdatePipelineSecrets(
	ctx context.Context,
	id string,
	workspaceId string,
	name string,
	value string,
) error

func (*TowerClient) UpdateWorkspace

func (c *TowerClient) UpdateWorkspace(ctx context.Context, id int64, fullName string, description string, visibility string) error

func (*TowerClient) UpdateWorkspaceParticipantRole added in v0.2.0

func (c *TowerClient) UpdateWorkspaceParticipantRole(ctx context.Context, workspaceId string, id int64, role string) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL