schema

Documentation

Index

• Constants
• type APIResponse
• type APIVersion
• type BatchJobResponse
• type BatchJobSubmission
• type DeleteResponse
• type DelimitedFiles
• type DeployResult
• type ErrorResponse
• type FilePathLister
• type InfoResponse
  • func (ir InfoResponse) GetNodesWithNodeGroupName(ngName string) []WorkerNodeInfo
• type ItemList
• type LogResponse
• type NodeInfo
• type RefreshResponse
• type S3Lister
• type TaskJobResponse
• type TaskJobSubmission
• type VerifyCortexResponse
• type WorkerNodeInfo

Constants

const (
	// Job Submission
	BatchSizeKey          = "batch_size"
	ItemsKey              = "items"
	ItemListKey           = "item_list"
	FilePathListerKey     = "file_path_lister"
	DelimitedFilesKey     = "delimited_files"
	S3PathsKey            = "s3_paths"
	IncludesKey           = "includes"
	ExcludesKey           = "excludes"
	WorkersKey            = "workers"
	TimeoutKey            = "timeout"
	MaxReceiveCountKey    = "max_receive_count"
	ARNKey                = "arn"
	SQSDeadLetterQueueKey = "sqs_dead_letter_queue"
)

Types

type APIResponse

type APIResponse struct {
	Spec             spec.API                `json:"spec"`
	Status           *status.Status          `json:"status,omitempty"`
	Endpoint         string                  `json:"endpoint"`
	DashboardURL     *string                 `json:"dashboard_url,omitempty"`
	BatchJobStatuses []status.BatchJobStatus `json:"batch_job_statuses,omitempty"`
	TaskJobStatuses  []status.TaskJobStatus  `json:"task_job_statuses,omitempty"`
	APIVersions      []APIVersion            `json:"api_versions,omitempty"`
}

type APIVersion

type APIVersion struct {
	APIID       string `json:"api_id"`
	LastUpdated int64  `json:"last_updated"`
}

type BatchJobResponse

type BatchJobResponse struct {
	APISpec   spec.API              `json:"api_spec"`
	JobStatus status.BatchJobStatus `json:"job_status"`
	Metrics   *metrics.BatchMetrics `json:"metrics,omitempty"`
	Endpoint  string                `json:"endpoint"`
}

type BatchJobSubmission

type BatchJobSubmission struct {
	spec.RuntimeBatchJobConfig
	ItemList       *ItemList       `json:"item_list"`
	FilePathLister *FilePathLister `json:"file_path_lister"`
	DelimitedFiles *DelimitedFiles `json:"delimited_files"`
}

type DeleteResponse

type DeleteResponse struct {
	Message string `json:"message"`
}

type DelimitedFiles

type DelimitedFiles struct {
	S3Lister
	BatchSize int `json:"batch_size"`
}

type DeployResult

type DeployResult struct {
	API     *APIResponse `json:"api"`
	Message string       `json:"message"`
	Error   string       `json:"error"`
}

type ErrorResponse

type ErrorResponse struct {
	Kind    string `json:"kind"`
	Message string `json:"message"`
}

type FilePathLister

type FilePathLister struct {
	S3Lister
	BatchSize int `json:"batch_size"`
}

type InfoResponse

type InfoResponse struct {
	ClusterConfig      clusterconfig.InternalConfig `json:"cluster_config" yaml:"cluster_config"`
	WorkerNodeInfos    []WorkerNodeInfo             `json:"worker_node_infos" yaml:"worker_node_infos"`
	OperatorNodeInfos  []NodeInfo                   `json:"operator_node_infos" yaml:"operator_node_infos"`
	NumPendingReplicas int                          `json:"num_pending_replicas" yaml:"num_pending_replicas"`
}

func (InfoResponse) GetNodesWithNodeGroupName

func (ir InfoResponse) GetNodesWithNodeGroupName(ngName string) []WorkerNodeInfo

type ItemList

type ItemList struct {
	Items     []json.RawMessage `json:"items"`
	BatchSize int               `json:"batch_size"`
}

type LogResponse

type LogResponse struct {
	LogURL string `json:"log_url"`
}

type NodeInfo

type NodeInfo struct {
	NodeGroupName string  `json:"nodegroup_name" yaml:"nodegroup_name"`
	InstanceType  string  `json:"instance_type" yaml:"instance_type"`
	IsSpot        bool    `json:"is_spot" yaml:"is_spot"`
	Price         float64 `json:"price" yaml:"price"`
}

type RefreshResponse

type RefreshResponse struct {
	Message string `json:"message"`
}

type S3Lister

type S3Lister struct {
	S3Paths    []string `json:"s3_paths"` // s3://<bucket_name>/key
	Includes   []string `json:"includes"`
	Excludes   []string `json:"excludes"`
	MaxResults *int64   `json:"-"` // this is not currently exposed to the user (it's used for validations)
}

type TaskJobResponse

type TaskJobResponse struct {
	APISpec   spec.API             `json:"api_spec"`
	JobStatus status.TaskJobStatus `json:"job_status"`
	Endpoint  string               `json:"endpoint"`
}

type TaskJobSubmission

type TaskJobSubmission struct {
	spec.RuntimeTaskJobConfig
}

type VerifyCortexResponse

type VerifyCortexResponse struct{}

type WorkerNodeInfo

type WorkerNodeInfo struct {
	NodeInfo
	Name                    string             `json:"name" yaml:"name"`
	NumReplicas             int                `json:"num_replicas" yaml:"num_replicas"`
	NumAsyncGatewayReplicas int                `json:"num_async_gateway_replicas" yaml:"num_async_gateway_replicas"`
	NumEnqueuerReplicas     int                `json:"num_enqueuer_replicas" yaml:"num_enqueuer_replicas"`
	ComputeUserCapacity     userconfig.Compute `json:"compute_user_capacity" yaml:"compute_user_capacity"`   // the total resources available to the user on a node
	ComputeAvailable        userconfig.Compute `json:"compute_available" yaml:"compute_unavailable"`         // unused resources on a node
	ComputeUserRequested    userconfig.Compute `json:"compute_user_requested" yaml:"compute_user_requested"` // total resources requested by user on a node
}