1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
|
// This file was automatically generated. DO NOT EDIT.
// If you have any remark or suggestion do not hesitate to open an issue.
// Package marketplace provides methods and message types of the marketplace v2 API.
package marketplace
import (
"bytes"
"encoding/json"
"fmt"
"net"
"net/http"
"net/url"
"strings"
"time"
"github.com/scaleway/scaleway-sdk-go/internal/errors"
"github.com/scaleway/scaleway-sdk-go/internal/marshaler"
"github.com/scaleway/scaleway-sdk-go/internal/parameter"
"github.com/scaleway/scaleway-sdk-go/namegenerator"
"github.com/scaleway/scaleway-sdk-go/scw"
)
// always import dependencies
var (
_ fmt.Stringer
_ json.Unmarshaler
_ url.URL
_ net.IP
_ http.Header
_ bytes.Reader
_ time.Time
_ = strings.Join
_ scw.ScalewayRequest
_ marshaler.Duration
_ scw.File
_ = parameter.AddToQuery
_ = namegenerator.GetRandomName
)
// API: marketplace API
type API struct {
client *scw.Client
}
// NewAPI returns a API object from a Scaleway client.
func NewAPI(client *scw.Client) *API {
return &API{
client: client,
}
}
type ListImagesRequestOrderBy string
const (
// ListImagesRequestOrderByNameAsc is [insert doc].
ListImagesRequestOrderByNameAsc = ListImagesRequestOrderBy("name_asc")
// ListImagesRequestOrderByNameDesc is [insert doc].
ListImagesRequestOrderByNameDesc = ListImagesRequestOrderBy("name_desc")
// ListImagesRequestOrderByCreatedAtAsc is [insert doc].
ListImagesRequestOrderByCreatedAtAsc = ListImagesRequestOrderBy("created_at_asc")
// ListImagesRequestOrderByCreatedAtDesc is [insert doc].
ListImagesRequestOrderByCreatedAtDesc = ListImagesRequestOrderBy("created_at_desc")
// ListImagesRequestOrderByUpdatedAtAsc is [insert doc].
ListImagesRequestOrderByUpdatedAtAsc = ListImagesRequestOrderBy("updated_at_asc")
// ListImagesRequestOrderByUpdatedAtDesc is [insert doc].
ListImagesRequestOrderByUpdatedAtDesc = ListImagesRequestOrderBy("updated_at_desc")
)
func (enum ListImagesRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "name_asc"
}
return string(enum)
}
func (enum ListImagesRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListImagesRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListImagesRequestOrderBy(ListImagesRequestOrderBy(tmp).String())
return nil
}
type ListLocalImagesRequestOrderBy string
const (
// ListLocalImagesRequestOrderByCreatedAtAsc is [insert doc].
ListLocalImagesRequestOrderByCreatedAtAsc = ListLocalImagesRequestOrderBy("created_at_asc")
// ListLocalImagesRequestOrderByCreatedAtDesc is [insert doc].
ListLocalImagesRequestOrderByCreatedAtDesc = ListLocalImagesRequestOrderBy("created_at_desc")
)
func (enum ListLocalImagesRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "created_at_asc"
}
return string(enum)
}
func (enum ListLocalImagesRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListLocalImagesRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListLocalImagesRequestOrderBy(ListLocalImagesRequestOrderBy(tmp).String())
return nil
}
type ListVersionsRequestOrderBy string
const (
// ListVersionsRequestOrderByCreatedAtAsc is [insert doc].
ListVersionsRequestOrderByCreatedAtAsc = ListVersionsRequestOrderBy("created_at_asc")
// ListVersionsRequestOrderByCreatedAtDesc is [insert doc].
ListVersionsRequestOrderByCreatedAtDesc = ListVersionsRequestOrderBy("created_at_desc")
)
func (enum ListVersionsRequestOrderBy) String() string {
if enum == "" {
// return default value if empty
return "created_at_asc"
}
return string(enum)
}
func (enum ListVersionsRequestOrderBy) MarshalJSON() ([]byte, error) {
return []byte(fmt.Sprintf(`"%s"`, enum)), nil
}
func (enum *ListVersionsRequestOrderBy) UnmarshalJSON(data []byte) error {
tmp := ""
if err := json.Unmarshal(data, &tmp); err != nil {
return err
}
*enum = ListVersionsRequestOrderBy(ListVersionsRequestOrderBy(tmp).String())
return nil
}
type Category struct {
ID string `json:"id"`
Name string `json:"name"`
Description string `json:"description"`
}
// Image: 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"`
// CreatedAt: creation date of this image
CreatedAt *time.Time `json:"created_at"`
// UpdatedAt: date of the last modification of this image
UpdatedAt *time.Time `json:"updated_at"`
// ValidUntil: expiration date of this image
ValidUntil *time.Time `json:"valid_until"`
// Label: label of this image
//
// Typically an identifier for a distribution (ex. "ubuntu_focal").
//
Label string `json:"label"`
}
type ListCategoriesResponse struct {
Categories []*Category `json:"categories"`
TotalCount uint32 `json:"total_count"`
}
type ListImagesResponse struct {
Images []*Image `json:"images"`
TotalCount uint32 `json:"total_count"`
}
type ListLocalImagesResponse struct {
LocalImages []*LocalImage `json:"local_images"`
TotalCount uint32 `json:"total_count"`
}
type ListVersionsResponse struct {
Versions []*Version `json:"versions"`
TotalCount uint32 `json:"total_count"`
}
// LocalImage: local image
type LocalImage struct {
// ID: UUID of this local image
//
// Version you will typically use to define an image in an API call.
//
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"`
}
// Version: version
type Version struct {
// ID: UUID of this version
ID string `json:"id"`
// Name: name of this version
Name string `json:"name"`
// CreatedAt: creation date of this image version
CreatedAt *time.Time `json:"created_at"`
// UpdatedAt: date of the last modification of this version
UpdatedAt *time.Time `json:"updated_at"`
// PublishedAt: date this version was officially published
PublishedAt *time.Time `json:"published_at"`
}
// Service API
type ListImagesRequest struct {
// PageSize: a positive integer lower or equal to 100 to select the number of items to display
PageSize *uint32 `json:"-"`
// Page: a positive integer to choose the page to display
Page *int32 `json:"-"`
// OrderBy: ordering to use
//
// Default value: name_asc
OrderBy ListImagesRequestOrderBy `json:"-"`
// Arch: choose for which machine architecture to return images
Arch *string `json:"-"`
// Category: choose the category of images to get
Category *string `json:"-"`
// IncludeEol: choose to include end-of-life images
IncludeEol bool `json:"-"`
}
// ListImages: list marketplace images
func (s *API) ListImages(req *ListImagesRequest, opts ...scw.RequestOption) (*ListImagesResponse, error) {
var err error
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "order_by", req.OrderBy)
parameter.AddToQuery(query, "arch", req.Arch)
parameter.AddToQuery(query, "category", req.Category)
parameter.AddToQuery(query, "include_eol", req.IncludeEol)
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/marketplace/v2/images",
Query: query,
Headers: http.Header{},
}
var resp ListImagesResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type GetImageRequest struct {
// ImageID: display the image name
ImageID string `json:"-"`
}
// GetImage: get a specific marketplace image
func (s *API) GetImage(req *GetImageRequest, opts ...scw.RequestOption) (*Image, error) {
var err error
if fmt.Sprint(req.ImageID) == "" {
return nil, errors.New("field ImageID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/marketplace/v2/images/" + fmt.Sprint(req.ImageID) + "",
Headers: http.Header{},
}
var resp Image
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type ListVersionsRequest struct {
ImageID string `json:"-"`
PageSize *uint32 `json:"-"`
Page *int32 `json:"-"`
// OrderBy:
//
// Default value: created_at_asc
OrderBy ListVersionsRequestOrderBy `json:"-"`
}
func (s *API) ListVersions(req *ListVersionsRequest, opts ...scw.RequestOption) (*ListVersionsResponse, error) {
var err error
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "image_id", req.ImageID)
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "order_by", req.OrderBy)
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/marketplace/v2/versions",
Query: query,
Headers: http.Header{},
}
var resp ListVersionsResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type GetVersionRequest struct {
VersionID string `json:"-"`
}
func (s *API) GetVersion(req *GetVersionRequest, opts ...scw.RequestOption) (*Version, error) {
var err error
if fmt.Sprint(req.VersionID) == "" {
return nil, errors.New("field VersionID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/marketplace/v2/versions/" + fmt.Sprint(req.VersionID) + "",
Headers: http.Header{},
}
var resp Version
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type ListLocalImagesRequest struct {
ImageID *string `json:"-"`
VersionID *string `json:"-"`
PageSize *uint32 `json:"-"`
Page *int32 `json:"-"`
// OrderBy:
//
// Default value: created_at_asc
OrderBy ListLocalImagesRequestOrderBy `json:"-"`
}
func (s *API) ListLocalImages(req *ListLocalImagesRequest, opts ...scw.RequestOption) (*ListLocalImagesResponse, error) {
var err error
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "image_id", req.ImageID)
parameter.AddToQuery(query, "version_id", req.VersionID)
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "page", req.Page)
parameter.AddToQuery(query, "order_by", req.OrderBy)
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/marketplace/v2/local-images",
Query: query,
Headers: http.Header{},
}
var resp ListLocalImagesResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type GetLocalImageRequest struct {
LocalImageID string `json:"-"`
}
func (s *API) GetLocalImage(req *GetLocalImageRequest, opts ...scw.RequestOption) (*LocalImage, error) {
var err error
if fmt.Sprint(req.LocalImageID) == "" {
return nil, errors.New("field LocalImageID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/marketplace/v2/local-images/" + fmt.Sprint(req.LocalImageID) + "",
Headers: http.Header{},
}
var resp LocalImage
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type ListCategoriesRequest struct {
PageSize *uint32 `json:"-"`
Page *int32 `json:"-"`
}
func (s *API) ListCategories(req *ListCategoriesRequest, opts ...scw.RequestOption) (*ListCategoriesResponse, error) {
var err error
defaultPageSize, exist := s.client.GetDefaultPageSize()
if (req.PageSize == nil || *req.PageSize == 0) && exist {
req.PageSize = &defaultPageSize
}
query := url.Values{}
parameter.AddToQuery(query, "page_size", req.PageSize)
parameter.AddToQuery(query, "page", req.Page)
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/marketplace/v2/categories",
Query: query,
Headers: http.Header{},
}
var resp ListCategoriesResponse
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
type GetCategoryRequest struct {
CategoryID string `json:"-"`
}
func (s *API) GetCategory(req *GetCategoryRequest, opts ...scw.RequestOption) (*Category, error) {
var err error
if fmt.Sprint(req.CategoryID) == "" {
return nil, errors.New("field CategoryID cannot be empty in request")
}
scwReq := &scw.ScalewayRequest{
Method: "GET",
Path: "/marketplace/v2/categories/" + fmt.Sprint(req.CategoryID) + "",
Headers: http.Header{},
}
var resp Category
err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListImagesResponse) UnsafeGetTotalCount() uint32 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListImagesResponse) UnsafeAppend(res interface{}) (uint32, error) {
results, ok := res.(*ListImagesResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Images = append(r.Images, results.Images...)
r.TotalCount += uint32(len(results.Images))
return uint32(len(results.Images)), nil
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListVersionsResponse) UnsafeGetTotalCount() uint32 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListVersionsResponse) UnsafeAppend(res interface{}) (uint32, error) {
results, ok := res.(*ListVersionsResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Versions = append(r.Versions, results.Versions...)
r.TotalCount += uint32(len(results.Versions))
return uint32(len(results.Versions)), nil
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListLocalImagesResponse) UnsafeGetTotalCount() uint32 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListLocalImagesResponse) UnsafeAppend(res interface{}) (uint32, error) {
results, ok := res.(*ListLocalImagesResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.LocalImages = append(r.LocalImages, results.LocalImages...)
r.TotalCount += uint32(len(results.LocalImages))
return uint32(len(results.LocalImages)), nil
}
// UnsafeGetTotalCount should not be used
// Internal usage only
func (r *ListCategoriesResponse) UnsafeGetTotalCount() uint32 {
return r.TotalCount
}
// UnsafeAppend should not be used
// Internal usage only
func (r *ListCategoriesResponse) UnsafeAppend(res interface{}) (uint32, error) {
results, ok := res.(*ListCategoriesResponse)
if !ok {
return 0, errors.New("%T type cannot be appended to type %T", res, r)
}
r.Categories = append(r.Categories, results.Categories...)
r.TotalCount += uint32(len(results.Categories))
return uint32(len(results.Categories)), nil
}
|