image

package

v0.3.3 Latest Latest Go to latest Published: Mar 12, 2024 License: MIT Imports: 4 Imported by: 0

Details

Package image provides access to the `/cloud/image` API endpoint.

This section is empty.

This section is empty.

This section is empty.

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

Client is a Service to work with API Jobs.

func New(c *api.Client) *Client

New is an initialisation function.

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

Get fetches a cloud image.

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

List returns a list of stack images, specific to the customer.

type GetRequest struct {
	Code string `json:"code"`
}

GetRequest represents a request to get a specific image from the /cloud/image/get.json endpoint.

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

GetResponse represents the return from the /cloud/images/get.json endpoint.

type ListResponse struct {
	Return struct {
		models.Pagination
		Images []models.Image `json:"data"`
	}
	models.APIResponse
}

ListResponse represents the return from the /cloud/images/list_all.json endpoint.