marketplace

Documentation

Overview

Package marketplace provides methods and message types of the marketplace v1 API.

Index

• type API
  • func NewAPI(client *scw.Client) *API
  • func (s *API) GetImage(req *GetImageRequest, opts ...scw.RequestOption) (*GetImageResponse, error)
  • func (s *API) GetLocalImageIDByLabel(req *GetLocalImageIDByLabelRequest) (string, error)
  • func (s *API) GetServiceInfo(req *GetServiceInfoRequest, opts ...scw.RequestOption) (*GetServiceInfoResponse, error)
  • func (s *API) GetVersion(req *GetVersionRequest, opts ...scw.RequestOption) (*GetVersionResponse, error)
  • func (s *API) ListImages(req *ListImagesRequest, opts ...scw.RequestOption) (*ListImagesResponse, error)
  • func (s *API) ListVersions(req *ListVersionsRequest, opts ...scw.RequestOption) (*ListVersionsResponse, error)
• type GetImageRequest
• type GetImageResponse
• type GetLocalImageIDByLabelRequest
• type GetServiceInfoRequest
• type GetServiceInfoResponse
• type GetVersionRequest
• type GetVersionResponse
• type Image
• type ListImagesRequest
• type ListImagesResponse
  • func (r *ListImagesResponse) UnsafeAppend(res interface{}) (uint32, error)
  • func (r *ListImagesResponse) UnsafeGetTotalCount() uint32
  • func (r *ListImagesResponse) UnsafeSetTotalCount(totalCount int)
• type ListVersionsRequest
• type ListVersionsResponse
  • func (r *ListVersionsResponse) UnsafeSetTotalCount(totalCount int)
• type LocalImage
• type Organization
• type Version

Types

type API

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

API: marketplace API

func NewAPI

func NewAPI(client *scw.Client) *API

NewAPI returns a API object from a Scaleway client.

func (*API) GetImage

func (s *API) GetImage(req *GetImageRequest, opts ...scw.RequestOption) (*GetImageResponse, error)

GetImage: get a specific marketplace image

func (*API) GetLocalImageIDByLabel

func (s *API) GetLocalImageIDByLabel(req *GetLocalImageIDByLabelRequest) (string, error)

GetLocalImageIDByLabel search for an image with the given label (exact match) in the given region it returns the latest version of this specific image.

func (*API) GetServiceInfo

func (s *API) GetServiceInfo(req *GetServiceInfoRequest, opts ...scw.RequestOption) (*GetServiceInfoResponse, error)

func (*API) GetVersion

func (s *API) GetVersion(req *GetVersionRequest, opts ...scw.RequestOption) (*GetVersionResponse, error)

func (*API) ListImages

func (s *API) ListImages(req *ListImagesRequest, opts ...scw.RequestOption) (*ListImagesResponse, error)

ListImages: list marketplace images

func (*API) ListVersions

func (s *API) ListVersions(req *ListVersionsRequest, opts ...scw.RequestOption) (*ListVersionsResponse, error)

type GetImageRequest

type GetImageRequest struct {
	// ImageID: display the image name
	ImageID string `json:"-"`
}

type GetImageResponse

type GetImageResponse struct {
	Image *Image `json:"image"`
}

type GetLocalImageIDByLabelRequest

type GetLocalImageIDByLabelRequest struct {
	ImageLabel     string
	Zone           scw.Zone
	CommercialType string
}

GetLocalImageIDByLabelRequest is used by GetLocalImageIDByLabel

type GetServiceInfoRequest

type GetServiceInfoRequest struct {
}

type GetServiceInfoResponse

type GetServiceInfoResponse struct {
	API string `json:"api"`

	Description string `json:"description"`

	Version string `json:"version"`
}

type GetVersionRequest

type GetVersionRequest struct {
	ImageID string `json:"-"`

	VersionID string `json:"-"`
}

type GetVersionResponse

type GetVersionResponse struct {
	Version *Version `json:"version"`
}

type Image

type Image struct {
	// ID: UUID of this image
	ID string `json:"id"`
	// Name: name of the image
	Name string `json:"name"`
	// Description: text description of this image
	Description string `json:"description"`
	// Logo: URL of this image's logo
	Logo string `json:"logo"`
	// Categories: list of categories this image belongs to
	Categories []string `json:"categories"`
	// CreationDate: creation date of this image
	CreationDate *time.Time `json:"creation_date"`
	// ModificationDate: date of the last modification of this image
	ModificationDate *time.Time `json:"modification_date"`
	// ValidUntil: expiration date of this image
	ValidUntil *time.Time `json:"valid_until"`
	// Label: label of this image
	Label string `json:"label"`
	// Versions: list of versions of this image
	Versions []*Version `json:"versions"`
	// Organization: organization this image belongs to
	Organization *Organization `json:"organization"`

	CurrentPublicVersion string `json:"current_public_version"`
}

Image: image

type ListImagesRequest

type ListImagesRequest struct {
	// PerPage: a positive integer lower or equal to 100 to select the number of items to display
	PerPage *uint32 `json:"-"`
	// Page: a positive integer to choose the page to display
	Page *int32 `json:"-"`
}

type ListImagesResponse

type ListImagesResponse struct {
	Images []*Image `json:"images"`

	TotalCount uint32 `json:"total_count"`
}

func (*ListImagesResponse) UnsafeAppend

func (r *ListImagesResponse) UnsafeAppend(res interface{}) (uint32, error)

UnsafeAppend should not be used Internal usage only

func (*ListImagesResponse) UnsafeGetTotalCount

func (r *ListImagesResponse) UnsafeGetTotalCount() uint32

UnsafeGetTotalCount should not be used Internal usage only

func (*ListImagesResponse) UnsafeSetTotalCount

func (r *ListImagesResponse) UnsafeSetTotalCount(totalCount int)

UnsafeSetTotalCount should not be used Internal usage only

type ListVersionsRequest

type ListVersionsRequest struct {
	ImageID string `json:"-"`
}

type ListVersionsResponse

type ListVersionsResponse struct {
	Versions []*Version `json:"versions"`

	TotalCount uint32 `json:"total_count"`
}

func (*ListVersionsResponse) UnsafeSetTotalCount

func (r *ListVersionsResponse) UnsafeSetTotalCount(totalCount int)

UnsafeSetTotalCount should not be used Internal usage only

type LocalImage

type LocalImage struct {
	// ID: UUID of this local image
	ID string `json:"id"`
	// CompatibleCommercialTypes: list of all commercial types that are compatible with this local image
	CompatibleCommercialTypes []string `json:"compatible_commercial_types"`
	// Arch: supported architecture for this local image
	Arch string `json:"arch"`
	// Zone: availability Zone where this local image is available
	Zone scw.Zone `json:"zone"`
}

LocalImage: local image

type Organization

type Organization struct {
	ID string `json:"id"`

	Name string `json:"name"`
}

type Version

type Version struct {
	// ID: UUID of this version
	ID string `json:"id"`
	// Name: name of this version
	Name string `json:"name"`
	// CreationDate: creation date of this image version
	CreationDate *time.Time `json:"creation_date"`
	// ModificationDate: date of the last modification of this version
	ModificationDate *time.Time `json:"modification_date"`
	// LocalImages: list of local images available in this version
	LocalImages []*LocalImage `json:"local_images"`
}

Version: version