registry

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

type CreateNamespaceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Name: define a namespace name.
	Name string `json:"name"`
	// Description: define a description.
	Description string `json:"description"`
	// Deprecated: OrganizationID: assign the namespace owner (deprecated).
	// Precisely one of OrganizationID, ProjectID must be set.
	OrganizationID *string `json:"organization_id,omitempty"`
	// ProjectID: assign the namespace to a project ID.
	// Precisely one of OrganizationID, ProjectID must be set.
	ProjectID *string `json:"project_id,omitempty"`
	// IsPublic: define the default visibility policy.
	IsPublic bool `json:"is_public"`
}

type DeleteImageRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ImageID: the unique ID of the Image.
	ImageID string `json:"-"`
}

type DeleteNamespaceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// NamespaceID: the unique ID of the Namespace.
	NamespaceID string `json:"-"`
}

type DeleteTagRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// TagID: the unique ID of the tag.
	TagID string `json:"-"`
	// Force: if two tags share the same digest the deletion will fail unless this parameter is set to true.
	Force bool `json:"-"`
}

type GetImageRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ImageID: the unique ID of the Image.
	ImageID string `json:"-"`
}

type GetNamespaceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// NamespaceID: the unique ID of the Namespace.
	NamespaceID string `json:"-"`
}

type GetTagRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// TagID: the unique ID of the Tag.
	TagID string `json:"-"`
}

type Image struct {
	// ID: the unique ID of the Image.
	ID string `json:"id"`
	// Name: the Image name, unique in a namespace.
	Name string `json:"name"`
	// NamespaceID: the unique ID of the Namespace the image belongs to.
	NamespaceID string `json:"namespace_id"`
	// Status: the status of the image.
	// Default value: unknown
	Status ImageStatus `json:"status"`
	// StatusMessage: details of the image status.
	StatusMessage *string `json:"status_message"`
	// Visibility: a `public` image is pullable from internet without authentication, opposed to a `private` image. `inherit` will use the namespace `is_public` parameter.
	// Default value: visibility_unknown
	Visibility ImageVisibility `json:"visibility"`
	// Size: image size in bytes, calculated from the size of image layers. One layer used in two tags of the same image is counted once but one layer used in two images is counted twice.
	Size scw.Size `json:"size"`
	// CreatedAt: creation date.
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: last modification date, from the user or the service.
	UpdatedAt *time.Time `json:"updated_at"`
	// Tags: list of docker tags of the image.
	Tags []string `json:"tags"`
}

type ImageStatus string

type ImageVisibility string

type ListImagesRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Page: a positive integer to choose the page to display.
	Page *int32 `json:"-"`
	// PageSize: a positive integer lower or equal to 100 to select the number of items to display.
	PageSize *uint32 `json:"-"`
	// OrderBy: field by which to order the display of Images.
	// Default value: created_at_asc
	OrderBy ListImagesRequestOrderBy `json:"-"`
	// NamespaceID: filter by the Namespace ID.
	NamespaceID *string `json:"-"`
	// Name: filter by the Image name (exact match).
	Name *string `json:"-"`
	// OrganizationID: filter by Organization ID.
	OrganizationID *string `json:"-"`
	// ProjectID: filter by Project ID.
	ProjectID *string `json:"-"`
}

type ListImagesRequestOrderBy string

type ListImagesResponse struct {
	// Images: paginated list of images matching filters.
	Images []*Image `json:"images"`
	// TotalCount: total number of images matching filters.
	TotalCount uint32 `json:"total_count"`
}

type ListNamespacesRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// Page: a positive integer to choose the page to display.
	Page *int32 `json:"-"`
	// PageSize: a positive integer lower or equal to 100 to select the number of items to display.
	PageSize *uint32 `json:"-"`
	// OrderBy: field by which to order the display of Images.
	// Default value: created_at_asc
	OrderBy ListNamespacesRequestOrderBy `json:"-"`
	// OrganizationID: filter by Organization ID.
	OrganizationID *string `json:"-"`
	// ProjectID: filter by Project ID.
	ProjectID *string `json:"-"`
	// Name: filter by the namespace name (exact match).
	Name *string `json:"-"`
}

type ListNamespacesRequestOrderBy string

type ListNamespacesResponse struct {
	// Namespaces: paginated list of namespaces matching filters.
	Namespaces []*Namespace `json:"namespaces"`
	// TotalCount: total number of namespaces matching filters.
	TotalCount uint32 `json:"total_count"`
}

type ListTagsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ImageID: the unique ID of the image.
	ImageID string `json:"-"`
	// Page: a positive integer to choose the page to display.
	Page *int32 `json:"-"`
	// PageSize: a positive integer lower or equal to 100 to select the number of items to display.
	PageSize *uint32 `json:"-"`
	// OrderBy: field by which to order the display of Images.
	// Default value: created_at_asc
	OrderBy ListTagsRequestOrderBy `json:"-"`
	// Name: filter by the tag name (exact match).
	Name *string `json:"-"`
}

type ListTagsRequestOrderBy string

type ListTagsResponse struct {
	// Tags: paginated list of tags matching filters.
	Tags []*Tag `json:"tags"`
	// TotalCount: total number of tags matching filters.
	TotalCount uint32 `json:"total_count"`
}

type Namespace struct {
	// ID: the unique ID of the namespace.
	ID string `json:"id"`
	// Name: the name of the namespace, unique in a region accross all organizations.
	Name string `json:"name"`
	// Description: description of the namespace.
	Description string `json:"description"`
	// OrganizationID: owner of the namespace.
	OrganizationID string `json:"organization_id"`
	// ProjectID: project of the namespace.
	ProjectID string `json:"project_id"`
	// Status: namespace status.
	// Default value: unknown
	Status NamespaceStatus `json:"status"`
	// StatusMessage: namespace status details.
	StatusMessage string `json:"status_message"`
	// Endpoint: endpoint reachable by docker.
	Endpoint string `json:"endpoint"`
	// IsPublic: namespace visibility policy.
	IsPublic bool `json:"is_public"`
	// Size: total size of the namespace, calculated as the sum of the size of all images in the namespace.
	Size scw.Size `json:"size"`
	// CreatedAt: creation date.
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: last modification date, from the user or the service.
	UpdatedAt *time.Time `json:"updated_at"`
	// ImageCount: number of images in the namespace.
	ImageCount uint32 `json:"image_count"`
	// Region: region the namespace belongs to.
	Region scw.Region `json:"region"`
}

type NamespaceStatus string

type Tag struct {
	// ID: the unique ID of the tag.
	ID string `json:"id"`
	// Name: tag name, unique for an image.
	Name string `json:"name"`
	// ImageID: image ID this tag belongs to.
	ImageID string `json:"image_id"`
	// Status: tag status.
	// Default value: unknown
	Status TagStatus `json:"status"`
	// Digest: hash of the tag actual content. Several tags of a same image may have the same digest.
	Digest string `json:"digest"`
	// CreatedAt: creation date.
	CreatedAt *time.Time `json:"created_at"`
	// UpdatedAt: last modification date, from the user or the service.
	UpdatedAt *time.Time `json:"updated_at"`
}

type TagStatus string

type UpdateImageRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// ImageID: image ID to update.
	ImageID string `json:"-"`
	// Visibility: a `public` image is pullable from internet without authentication, opposed to a `private` image. `inherit` will use the namespace `is_public` parameter.
	// Default value: visibility_unknown
	Visibility ImageVisibility `json:"visibility"`
}

type UpdateNamespaceRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`
	// NamespaceID: namespace ID to update.
	NamespaceID string `json:"-"`
	// Description: define a description.
	Description *string `json:"description"`
	// IsPublic: define the default visibility policy.
	IsPublic *bool `json:"is_public"`
}

type WaitForImageRequest struct {
	ImageID       string
	Region        scw.Region
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

type WaitForNamespaceRequest struct {
	NamespaceID   string
	Region        scw.Region
	Timeout       *time.Duration
	RetryInterval *time.Duration
}

type WaitForTagRequest struct {
	TagID         string
	Region        scw.Region
	Timeout       *time.Duration
	RetryInterval *time.Duration
}