v1payload

package
v0.4.13 Latest Latest
Warning

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

Go to latest
Published: May 29, 2017 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

View Source
const (
	//DatasetUploadStatusCreated is the created upload status
	DatasetUploadStatusCreated = "CREATED"
	//DatasetUploadStatusUploading is the uploading upload status
	DatasetUploadStatusUploading = "UPLOADING"
	//DatasetUploadStatusSuccess is the success upload status
	DatasetUploadStatusSuccess = "SUCCESS"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateDatasetInput

type CreateDatasetInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	Tag       string `json:"tag" valid:"noDatasetPrefix"`
}

CreateDatasetInput is used as input to dataset creation

type CreateDatasetOutput

type CreateDatasetOutput struct {
	DatasetSummary
	HeartbeatInterval time.Duration `json:"heartbeat_interval"`
}

CreateDatasetOutput is returned from creating a dataset

type CreateQueueInput

type CreateQueueInput struct {
	ProjectID string `json:"project_id" valid:"required"`
}

CreateQueueInput is input for queue creation

type CreateQueueOutput

type CreateQueueOutput struct {
	QueueSummary
}

CreateQueueOutput is output for queue creation

type CreateTokenInput

type CreateTokenInput struct {
	ProjectID string `json:"project_id" valid:"required"`
}

CreateTokenInput is input for token creation

type CreateTokenOutput

type CreateTokenOutput struct {
	AWSRegion          string    `json:"aws_region"`
	AWSAccessKeyID     string    `json:"aws_access_key_id"`
	AWSExpiration      time.Time `json:"aws_expiration"`
	AWSSecretAccessKey string    `json:"aws_secret_access_key"`
	AWSSessionToken    string    `json:"aws_session_token"`
}

CreateTokenOutput is output for token creation

type DatasetSummary

type DatasetSummary struct {
	ProjectID    string `json:"project_id"`
	DatasetID    string `json:"dataset_id"`
	Bucket       string `json:"bucket"`
	DatasetRoot  string `json:"dataset_root"`
	ProjectRoot  string `json:"project_root"`
	UploadExpire int64  `json:"upload_expire"`
	UploadStatus string `json:"upload_status"`
	Tag          string `json:"tag,omitempty"`
}

DatasetSummary is a small version of

type DeleteQueueInput

type DeleteQueueInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	QueueID   string `json:"queue_id" valid:"required"`
}

DeleteQueueInput is input for queue creation

type DeleteQueueOutput

type DeleteQueueOutput struct{}

DeleteQueueOutput is output for queue creation

type DescribeDatasetInput

type DescribeDatasetInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	DatasetID string `json:"dataset_id" valid:"required"`
}

DescribeDatasetInput is input for queue creation

type DescribeDatasetOutput

type DescribeDatasetOutput struct {
	DatasetSummary
}

DescribeDatasetOutput is output for queue creation

type DescribeQueueInput

type DescribeQueueInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	QueueID   string `json:"queue_id"`
}

DescribeQueueInput is input for getting queue information

type DescribeQueueOutput

type DescribeQueueOutput struct {
	QueueSummary
}

DescribeQueueOutput is output for queue creation

type DescribeTaskInput

type DescribeTaskInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	QueueID   string `json:"queue_id" valid:"required"`
	TaskID    int64  `json:"task_id" valid:"required"`
}

DescribeTaskInput is input for queue creation

type DescribeTaskOutput

type DescribeTaskOutput struct {
	TaskSummary
	ExecutionARN   string `json:"execution_arn"`
	NumDispatches  int64  `json:"num_dispatches"`
	Result         string `json:"result,omitempty"`
	LastErrCode    string `json:"last_err_code,omitempty"`
	LastErrMessage string `json:"last_err_message,omitempty"`
}

DescribeTaskOutput is output for queue creation

type Error

type Error struct {

	//Retry indicates if the client can retry the request as is, this is mostly false on validation/encoding errors and true in other cases
	Retry bool `json:"retry"`

	//Message contains a overall message to the user, it should always be set to provide some feedback
	Message string `json:"message"`

	//Trace is set if the server is running in development mode, if it is empty it can be ignored
	Trace []string `json:"trace,omitempty"`

	//Fields can hold validation messages for individual fields, if empty the cause of the overal error is not due to specific field's input
	Fields map[string]string `json:"fields,omitempty"`
}

Error struct is returned by the API if anything goes wrong

func (Error) Error

func (e Error) Error() string

Error returns the error message.

type ExpelProjectInput

type ExpelProjectInput struct {
	ProjectID string `json:"project_id" valid:"required"`
}

ExpelProjectInput is input for queue creation

type ExpelProjectOutput

type ExpelProjectOutput struct{}

ExpelProjectOutput is output for queue creation

type ListDatasetsInput

type ListDatasetsInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	Tag       string `json:"tag,omitempty"`
}

ListDatasetsInput is input for queue creation

type ListDatasetsOutput

type ListDatasetsOutput struct {
	Datasets []*DatasetSummary
}

ListDatasetsOutput is output for queue creation

type ListQueuesInput

type ListQueuesInput struct {
	ProjectID string `json:"project_id" valid:"required"`
}

ListQueuesInput is input for queue creation

type ListQueuesOutput

type ListQueuesOutput struct {
	Queues []*QueueSummary
}

ListQueuesOutput is output for queue creation

type ListTasksInput

type ListTasksInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	QueueID   string `json:"queue_id" valid:"required"`
}

ListTasksInput is input for queue creation

type ListTasksOutput

type ListTasksOutput struct {
	Tasks []*TaskSummary
}

ListTasksOutput is output for queue creation

type ListWorkersInput

type ListWorkersInput struct {
	ProjectID string `json:"project_id" valid:"required"`
}

ListWorkersInput is input for queue creation

type ListWorkersOutput

type ListWorkersOutput struct {
	Workers []*WorkerSummary
}

ListWorkersOutput is output for queue creation

type PlaceProjectInput

type PlaceProjectInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	Host      string `json:"host" valid:"required"`
	Token     string `json:"token"`
	CAPem     string `json:"ca_pem"`
	Password  string `json:"password"`
	Username  string `json:"username"`
	Insecure  bool   `json:"insecure"`
}

PlaceProjectInput is input for queue creation

type PlaceProjectOutput

type PlaceProjectOutput struct {
}

PlaceProjectOutput is output for queue creation

type QueueSummary

type QueueSummary struct {
	ProjectID string `json:"project_id"`
	QueueID   string `json:"queue_id"`
	QueueURL  string `json:"queue_url"`
}

QueueSummary is a smaller representation of a queue

type Run

type Run struct {
	ProjectID string `json:"project_id"`
	QueueID   string `json:"queue_id"`
	TaskID    int64  `json:"task_id"`
	Token     string `json:"token"`

	Cmd   []string          `json:"cmd"`
	Env   map[string]string `json:"env"`
	Stdin []byte            `json:"stdin"`
}

An Run acts as an reference to a task instance

type SendRunFailureInput

type SendRunFailureInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	QueueID   string `json:"queue_id" valid:"required"`
	TaskID    int64  `json:"task_id" valid:"required"`
	RunToken  string `json:"run_token" valid:"required"`

	ErrorCode    string `json:"error_code"`
	ErrorMessage string `json:"error_message"`
}

SendRunFailureInput is input for marking a run as failed

type SendRunFailureOutput

type SendRunFailureOutput struct{}

SendRunFailureOutput is output from marking a run as failed

type SendRunHeartbeatInput

type SendRunHeartbeatInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	QueueID   string `json:"queue_id" valid:"required"`
	TaskID    int64  `json:"task_id" valid:"required"`
	RunToken  string `json:"run_token" valid:"required"`
}

SendRunHeartbeatInput is input for queue creation

type SendRunHeartbeatOutput

type SendRunHeartbeatOutput struct {
	HasExpired bool `json:"has_expired"`
}

SendRunHeartbeatOutput is output for queue creation

type SendRunSuccessInput

type SendRunSuccessInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	QueueID   string `json:"queue_id" valid:"required"`
	TaskID    int64  `json:"task_id" valid:"required"`
	RunToken  string `json:"run_token" valid:"required"`

	Result string `json:"result"`
}

SendRunSuccessInput is input for marking a run as failed

type SendRunSuccessOutput

type SendRunSuccessOutput struct{}

SendRunSuccessOutput is output from marking a run as failed

type SendUploadHeartbeatInput

type SendUploadHeartbeatInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	DatasetID string `json:"dataset_id" valid:"required"`
}

SendUploadHeartbeatInput is input for dataset creation

type SendUploadHeartbeatOutput

type SendUploadHeartbeatOutput struct {
	HasExpired bool `json:"has_expired"`
}

SendUploadHeartbeatOutput is output for dataset creation

type SendUploadSuccessInput

type SendUploadSuccessInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	DatasetID string `json:"dataset_id" valid:"required"`
}

SendUploadSuccessInput is input for marking a run as failed

type SendUploadSuccessOutput

type SendUploadSuccessOutput struct{}

SendUploadSuccessOutput is output from marking a run as failed

type StartTaskInput

type StartTaskInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	QueueID   string `json:"queue_id" valid:"required"`

	Cmd   []string          `json:"cmd"`
	Env   map[string]string `json:"env"`
	Stdin []byte            `json:"stdin"`
}

StartTaskInput is input for queue creation

type StartTaskOutput

type StartTaskOutput struct {
	TaskSummary
}

StartTaskOutput is output for queue creation

type StartWorkerInput

type StartWorkerInput struct {
	ProjectID      string            `json:"project_id" valid:"required"`
	Image          string            `json:"image" valid:"required"`
	QueueID        string            `json:"queue_id" valid:"required"`
	InputDatasetID string            `json:"input_dataset_id"`
	Env            map[string]string `json:"env"`
}

StartWorkerInput is input for queue creation

type StartWorkerOutput

type StartWorkerOutput struct {
	ProjectID string `json:"project_id" valid:"required"`
	WorkerID  string `json:"worker_id" valid:"required"`
}

StartWorkerOutput is output for queue creation

type StopTaskInput

type StopTaskInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	QueueID   string `json:"queue_id" valid:"required"`
	TaskID    int64  `json:"task_id" valid:"required"`
}

StopTaskInput is input for queue creation

type StopTaskOutput

type StopTaskOutput struct{}

StopTaskOutput is output for queue creation

type StopWorkerInput

type StopWorkerInput struct {
	ProjectID string `json:"project_id" valid:"required"`
	WorkerID  string `json:"worker_id" valid:"required"`
}

StopWorkerInput is input for queue creation

type StopWorkerOutput

type StopWorkerOutput struct{}

StopWorkerOutput is output for queue creation

type TaskSummary

type TaskSummary struct {
	TaskID  int64  `json:"task_id"`
	QueueID string `json:"queue_id"`
	Status  string `json:"status,omitempty"`
}

TaskSummary is a small version of

type WorkerSummary

type WorkerSummary struct {
	ProjectID string `json:"project_id"`
	WorkerID  string `json:"worker_id"`
}

WorkerSummary is a smaller representation of a queue

Jump to

Keyboard shortcuts

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