Documentation
¶
Overview ¶
Package client provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.
Index ¶
- type BuildConfig
- type Image
- type ImageVersion
- type Region
- type RunTask
- type Runtime
- type Task
- type TaskData
- type TaskIDParam
- type TaskIdFilterParam
- type TaskIdentifier
- type TaskRun
- type TaskRunDetails
- type TaskRunIDParam
- type TaskRunResult
- type TaskRunStatus
- type TaskSlug
- type Workflow
- type WorkflowCreate
- type WorkflowIDParam
- type WorkflowUpdate
- type WorkflowVersion
- type WorkflowVersionIDParam
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BuildConfig ¶
type BuildConfig struct {
// Branch The branch to use for the build, if applicable.
Branch *string `json:"branch,omitempty"`
// BuildCommand The command to run to build the workflow.
BuildCommand string `json:"buildCommand"`
// Repo The repository URL to use for the build.
Repo string `json:"repo"`
// RootDir The root directory of the repository to use for the build, if applicable.
RootDir *string `json:"rootDir,omitempty"`
// Runtime The runtime environment for the workflow (e.g., node, python, etc.).
Runtime Runtime `json:"runtime"`
}
BuildConfig defines model for BuildConfig.
type Image ¶
type Image struct {
// ImagePath Path to the image used for this server (e.g docker.io/library/nginx:latest).
ImagePath string `json:"imagePath"`
// RegistryCredentialId Optional reference to the registry credential passed to the image repository to retrieve this image.
RegistryCredentialId *string `json:"registryCredentialId,omitempty"`
}
Image defines model for Image.
type ImageVersion ¶
type ImageVersion struct {
// ImagePath Path to the image used for this server (e.g docker.io/library/nginx:latest).
ImagePath string `json:"imagePath"`
// RegistryCredentialId Optional reference to the registry credential passed to the image repository to retrieve this image.
RegistryCredentialId *string `json:"registryCredentialId,omitempty"`
// Sha SHA that the image reference was resolved to when creating the workflow version.
Sha string `json:"sha"`
}
ImageVersion defines model for ImageVersion.
type RunTask ¶
type RunTask struct {
Input TaskData `json:"input"`
// Task Either a task ID or a workflow slug with task name and optional version. If a version is not provided, the latest version of the task will be used.
Task TaskIdentifier `json:"task"`
}
RunTask defines model for RunTask.
type Runtime ¶
type Runtime string
Runtime The runtime environment for the workflow (e.g., node, python, etc.).
type Task ¶
type Task struct {
CreatedAt time.Time `json:"createdAt"`
Id string `json:"id"`
Name string `json:"name"`
}
Task defines model for Task.
type TaskIdFilterParam ¶
type TaskIdFilterParam = []string
TaskIdFilterParam defines model for TaskIdFilterParam.
type TaskIdentifier ¶
type TaskIdentifier = string
TaskIdentifier Either a task ID or a workflow slug with task name and optional version. If a version is not provided, the latest version of the task will be used.
type TaskRun ¶
type TaskRun struct {
CompletedAt *time.Time `json:"completedAt,omitempty"`
Id string `json:"id"`
StartedAt *time.Time `json:"startedAt,omitempty"`
Status TaskRunStatus `json:"status"`
TaskId string `json:"taskId"`
}
TaskRun defines model for TaskRun.
type TaskRunDetails ¶
type TaskRunDetails struct {
CompletedAt *time.Time `json:"completedAt,omitempty"`
// Error Error message if the task run failed.
Error *string `json:"error,omitempty"`
Id string `json:"id"`
Results TaskRunResult `json:"results"`
StartedAt *time.Time `json:"startedAt,omitempty"`
Status TaskRunStatus `json:"status"`
TaskId string `json:"taskId"`
}
TaskRunDetails defines model for TaskRunDetails.
type TaskRunResult ¶
type TaskRunResult = []interface{}
TaskRunResult defines model for TaskRunResult.
type TaskRunStatus ¶
type TaskRunStatus string
TaskRunStatus defines model for TaskRunStatus.
const ( Completed TaskRunStatus = "completed" Failed TaskRunStatus = "failed" Pending TaskRunStatus = "pending" Running TaskRunStatus = "running" )
Defines values for TaskRunStatus.
type TaskSlug ¶
type TaskSlug struct {
TaskName string `json:"taskName"`
Version *string `json:"version,omitempty"`
WorkflowServiceSlug string `json:"workflowServiceSlug"`
}
TaskSlug defines model for TaskSlug.
type Workflow ¶
type Workflow struct {
BuildConfig *BuildConfig `json:"buildConfig,omitempty"`
CreatedAt time.Time `json:"createdAt"`
Id string `json:"id"`
Image *Image `json:"image,omitempty"`
Name string `json:"name"`
OwnerId string `json:"ownerId"`
// Region Defaults to "oregon"
Region Region `json:"region"`
// RunCommand Command to run the workflow.
RunCommand *string `json:"runCommand,omitempty"`
UpdatedAt time.Time `json:"updatedAt"`
}
Workflow defines model for Workflow.
type WorkflowCreate ¶
type WorkflowCreate struct {
BuildConfig *BuildConfig `json:"buildConfig,omitempty"`
Image *Image `json:"image,omitempty"`
Name string `json:"name"`
OwnerId string `json:"ownerId"`
// Region Defaults to "oregon"
Region Region `json:"region"`
// RunCommand The command to run the workflow
RunCommand *string `json:"runCommand,omitempty"`
}
WorkflowCreate defines model for WorkflowCreate.
type WorkflowIDParam ¶
type WorkflowIDParam = string
WorkflowIDParam defines model for WorkflowIDParam.
type WorkflowUpdate ¶
type WorkflowUpdate struct {
BuildConfig *BuildConfig `json:"buildConfig,omitempty"`
Image *Image `json:"image,omitempty"`
Name *string `json:"name,omitempty"`
// RunCommand The command to run the workflow
RunCommand *string `json:"runCommand,omitempty"`
}
WorkflowUpdate defines model for WorkflowUpdate.
type WorkflowVersion ¶
type WorkflowVersion struct {
CreatedAt time.Time `json:"createdAt"`
Id string `json:"id"`
Image ImageVersion `json:"image"`
Name string `json:"name"`
WorkflowId string `json:"workflowId"`
}
WorkflowVersion defines model for WorkflowVersion.
type WorkflowVersionIDParam ¶
type WorkflowVersionIDParam = string
WorkflowVersionIDParam defines model for WorkflowVersionIDParam.