volume

type AddOptions ¶

type AddOptions struct {
	ServerName     string
	VolumeName     string
	ContainerNames []string
}

AddOptions describes a new volume to create. ContainerNames is an optional list of container identifiers to attach the volume to at creation time.

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

Client is a Service to work with the SiteHost Cloud Volume API.

func New(c *api.Client) *Client

func (s *Client) Add(ctx context.Context, opt AddOptions) (response JobResponse, err error)

func (s *Client) Delete(ctx context.Context, opt DeleteOptions) (response JobResponse, err error)

func (s *Client) Get(ctx context.Context, opt GetOptions) (response GetResponse, err error)

func (s *Client) List(ctx context.Context, opt *ListOptions) (response ListResponse, err error)

func (s *Client) Mount(ctx context.Context, opt MountOptions) (response JobResponse, err error)

containers[<stack_name>][] = <container_name>

func (s *Client) UpdateMounts(ctx context.Context, opt UpdateMountsOptions) (response JobResponse, err error)

containers[add][<stack_name>][] = <container_name>
containers[remove][<stack_name>][] = <container_name>

type ContainerMount ¶

type ContainerMount struct {
	StackName     string
	ContainerName string
}

ContainerMount describes a single container target for volume mount / unmount operations: the stack the container belongs to and the container's name.

type DeleteOptions ¶

type DeleteOptions struct {
	Server string `url:"server"`
	Volume string `url:"volume"`
}

DeleteOptions identifies the volume to delete. Same parameter naming as GetOptions.

type GetOptions ¶

type GetOptions struct {
	Server string `url:"server"`
	Volume string `url:"volume"`
}

GetOptions identifies the volume to fetch.

Note: get and delete use the unprefixed parameter names (server / volume) — distinct from add / mount / update_mounts which use server_name / volume_name. This reflects the API's actual surface; tags are explicit.

type GetResponse ¶

type GetResponse struct {
	Return Volume `json:"return"`
	models.APIResponse
}

GetResponse represents the response from get.

type JobResponse ¶

type JobResponse struct {
	Return struct {
		models.Job `json:"job"`
	} `json:"return"`
	models.APIResponse
}

JobResponse is the shared response shape for the write operations (add, delete, mount, update_mounts). Each queues an asynchronous scheduler job; the job ID is returned for tracking.

type ListOptions ¶

type ListOptions struct {
	Name       string `url:"filters[name],omitempty"`
	ServerName string `url:"filters[server_name],omitempty"`
	Container  string `url:"filters[container],omitempty"`
	SortBy     string `url:"filters[sort_by],omitempty"`
	SortDir    string `url:"filters[sort_dir],omitempty"`
	PageSize   int    `url:"filters[page_size],omitempty"`
	PageNumber int    `url:"filters[page_number],omitempty"`
}

ListOptions represents optional filters for the list_all call. All fields are optional.

type ListResponse ¶

type ListResponse struct {
	Return struct {
		models.Pagination
		Data []Volume `json:"data"`
	} `json:"return"`
	models.APIResponse
}

ListResponse represents the response from list_all.

type MountOptions ¶

type MountOptions struct {
	ServerName string
	VolumeName string
	Containers []ContainerMount
}

MountOptions describes a volume to mount and the containers to mount it to.

type UpdateMountsOptions ¶

type UpdateMountsOptions struct {
	ServerName string
	VolumeName string
	Add        []ContainerMount
	Remove     []ContainerMount
}

UpdateMountsOptions describes incremental mount changes — containers to attach (Add) and detach (Remove). Either or both may be set.

type Volume ¶

type Volume struct {
	ID          string   `json:"id"`
	ClientID    string   `json:"client_id"`
	ServerID    string   `json:"server_id"`
	Pending     string   `json:"pending"`
	VolumeName  string   `json:"volume_name"`
	IsMissing   string   `json:"is_missing"`
	DateAdded   string   `json:"date_added"`
	DateUpdated string   `json:"date_updated"`
	ServerName  string   `json:"server_name"`
	ServerLabel string   `json:"server_label"`
	ServerOwner bool     `json:"server_owner"`
	Containers  []string `json:"containers"`
}

Volume describes a single cloud volume.

String-typed boolean fields (IsMissing) reflect the API's actual response shape ("0"/"1"). Pending is non-empty while an operation is in flight (e.g. "adding:29658430"); empty when stable.

Containers is a list of container identifiers the volume is currently attached to; empty when not mounted anywhere.