payload

package
v0.3.1 Latest Latest
Warning

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

Go to latest
Published: Mar 30, 2017 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuthError added in v0.2.3

type AuthError struct {
	Detail string `json:"detail"`
}

func (AuthError) Error added in v0.2.3

func (e AuthError) Error() string

type Dataset

type Dataset struct {
	ProjectID string `json:"project_id"`
	DatasetID string `json:"dataset_id"`
	Bucket    string `json:"bucket"`
	Root      string `json:"root"`
}

Dataset is a dataset in the list output

type DatasetCreateInput

type DatasetCreateInput struct{}

DatasetCreateInput is used as input to dataset creation

type DatasetCreateOutput

type DatasetCreateOutput struct {
	Dataset
}

DatasetCreateOutput is returned from creating a dataset

type DatasetDescribeOutput

type DatasetDescribeOutput struct {
	Dataset
}

DatasetDescribeOutput is returned from a specific dataset

type DatasetListOutput

type DatasetListOutput struct {
	Datasets []*Dataset `json:"datasets"`
}

DatasetListOutput is returned from the dataset listing

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

type NerdClaims

type NerdClaims struct {
	*jwt.StandardClaims
	ProjectID string `json:"proj,omitempty"`
}

NerdClaims hold nerdalize specific jwt claims

type SessionCreateOutput

type SessionCreateOutput struct {
	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"`

	AWSQueueURL      string `json:"aws_queue_url"`
	AWSStorageBucket string `json:"aws_storage_bucket"`
	AWSStorageRoot   string `json:"aws_storage_root"`
}

SessionCreateOutput is returned when a user created a valid session

type Task

type Task struct {
	ProjectID     string            `json:"project_id"`
	TaskID        string            `json:"task_id"`
	InputID       string            `json:"input_id"`
	OutputID      string            `json:"output_id,omitempty"`
	WorkerID      string            `json:"worker_id,omitempty"`
	Image         string            `json:"image"`
	Environment   map[string]string `json:"environment,omitempty"`
	CreatedAt     time.Time         `json:"created_at"`
	ActivityToken string            `json:"activity_token,omitempty"`
}

Task is a task in the list output

type TaskCreateInput

type TaskCreateInput struct {
	Image       string            `json:"image" valid:"min=1,max=64,required"`
	InputID     string            `json:"input_id" valid:"datasetid"`
	Environment map[string]string `json:"environment"`
}

TaskCreateInput is used as input to task creation

type TaskCreateOutput

type TaskCreateOutput struct {
	Task
}

TaskCreateOutput is returned from

type TaskDescribeOutput

type TaskDescribeOutput struct {
	Task
}

TaskDescribeOutput is returned from a specific task

type TaskListOutput

type TaskListOutput struct {
	Tasks []*TaskSummary `json:"tasks"`
}

TaskListOutput is returned from the task listing

type TaskResult

type TaskResult struct {
	ProjectID  string `json:"project_id"`
	TaskID     string `json:"task_id"`
	OutputID   string `json:"output_id"`
	ExitStatus string `json:"exit_status"`
}

TaskResult is used when the worker needs to provide results of the execution

type TaskSummary

type TaskSummary struct {
	ProjectID string    `json:"project_id"`
	TaskID    string    `json:"task_id"`
	OutputID  string    `json:"output_id,omitempty"`
	CreatedAt time.Time `json:"created_at"`
}

TaskSummary is a summarized view of a task

type Worker

type Worker struct {
	ProjectID    string `json:"project_id"`
	WorkerID     string `json:"worker_id"`
	QueueURL     string `json:"queue_url"`
	LogGroupName string `json:"log_group_name"`
}

Worker is a worker in the list output

type WorkerCreateInput

type WorkerCreateInput struct{}

WorkerCreateInput is used as input to worker creation

type WorkerCreateOutput

type WorkerCreateOutput struct {
	Worker
}

WorkerCreateOutput is returned from creating a worker

type WorkerDescribeOutput

type WorkerDescribeOutput struct {
	Worker
}

WorkerDescribeOutput is returned from a specific worker

type WorkerListOutput

type WorkerListOutput struct {
	Workers []*Worker `json:"workers"`
}

WorkerListOutput is returned from the worker listing

Jump to

Keyboard shortcuts

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