types

Documentation

Index

• type AuthMiddlewareRequest
• type AuthRequest
• type AuthResponse
• type Environment
• type EnvironmentCreateRequest
• type EnvironmentCreateResponse
• type EnvironmentGetRequest
• type EnvironmentGetResponse
• type EnvironmentListRequest
• type EnvironmentListResponse
• type EnvironmentPort
• type EnvironmentRemoveRequest
• type EnvironmentRemoveResponse
• type EnvironmentRepoInfo
• type EnvironmentSpec
• type EnvironmentStatus
• type ImageGetRequest
• type ImageGetResponse
• type ImageInfo
• type ImageListRequest
• type ImageListResponse
• type ImageMeta
• type ObjectMeta

Types

type AuthMiddlewareRequest

type AuthMiddlewareRequest struct {
	// Use auth instead of in the request body.
	IdentityToken string `uri:"identity_token" example:"a332139d39b89a241400013700e665a3"`
}

type AuthRequest

type AuthRequest struct {
	// Username  string `json:"username,omitempty"`
	// Password  string `json:"password,omitempty"`
	PublicKey string `json:"public_key"`

	// IdentityToken is used to authenticate the user and get
	// an access token for the registry.
	// Required: true
	IdentityToken string `json:"identity_token" example:"a332139d39b89a241400013700e665a3"`
}

AuthRequest contains authorization information for connecting to a envd server.

type AuthResponse

type AuthResponse struct {
	// An opaque token used to authenticate a user after a successful login
	// Required: true
	IdentityToken string `json:"identity_token" example:"a332139d39b89a241400013700e665a3"`
	// The status of the authentication
	// Required: true
	Status string `json:"status" example:"Login successfully"`
}

type Environment

type Environment struct {
	ObjectMeta `json:",inline"`
	Spec       EnvironmentSpec   `json:"spec,omitempty"`
	Status     EnvironmentStatus `json:"status,omitempty"`
}

type EnvironmentCreateRequest

type EnvironmentCreateRequest struct {
	Environment `json:",inline,omitempty"`
}

type EnvironmentCreateResponse

type EnvironmentCreateResponse struct {
	Created Environment `json:"environment,omitempty"`

	// Warnings encountered when creating the pod
	// Required: true
	Warnings []string `json:"warnings,omitempty"`
}

type EnvironmentGetRequest

type EnvironmentGetRequest struct {
	Name string `uri:"name" example:"pytorch-example"`
}

type EnvironmentGetResponse

type EnvironmentGetResponse struct {
	Environment `json:",inline"`
}

type EnvironmentListRequest

type EnvironmentListRequest struct {
}

type EnvironmentListResponse

type EnvironmentListResponse struct {
	Items []Environment `json:"items,omitempty"`
}

type EnvironmentPort

type EnvironmentPort struct {
	Name string `json:"name,omitempty"`
	Port int32  `json:"port,omitempty"`
}

type EnvironmentRemoveRequest

type EnvironmentRemoveRequest struct {
	Name string `uri:"name" example:"pytorch-example"`
}

type EnvironmentRemoveResponse

type EnvironmentRemoveResponse struct {
}

type EnvironmentRepoInfo

type EnvironmentRepoInfo struct {
	URL         string `json:"url,omitempty"`
	Description string `json:"description,omitempty"`
}

type EnvironmentSpec

type EnvironmentSpec struct {
	Owner string            `json:"owner,omitempty"`
	Image string            `json:"image,omitempty"`
	Env   []string          `json:"env,omitempty"`
	Cmd   []string          `json:"cmd,omitempty"`
	Ports []EnvironmentPort `json:"ports,omitempty"`
}

type EnvironmentStatus

type EnvironmentStatus struct {
	Phase             string  `json:"phase,omitempty"`
	JupyterAddr       *string `json:"jupyter_addr,omitempty"`
	RStudioServerAddr *string `json:"rstudio_server_addr,omitempty"`
}

type ImageGetRequest

type ImageGetRequest struct {
	Name string `uri:"name" example:"pytorch-example"`
}

type ImageGetResponse

type ImageGetResponse struct {
	ImageMeta `json:",inline"`
}

type ImageInfo

type ImageInfo struct {
	OwnerToken string
	ImageMeta
}

type ImageListRequest

type ImageListRequest struct {
}

type ImageListResponse

type ImageListResponse struct {
	Items []ImageMeta `json:"items,omitempty"`
}

type ImageMeta

type ImageMeta struct {
	Name    string            `json:"name" example:"pytorch-cuda:dev"`
	Digest  string            `json:"digest,omitempty"`
	Created int64             `json:"created,omitempty"`
	Size    int64             `json:"size,omitempty"`
	Labels  map[string]string `json:"labels,omitempty"`
}

type ObjectMeta

type ObjectMeta struct {
	Name string `json:"name,omitempty"`

	Labels map[string]string `json:"labels,omitempty"`
}