file

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

type Attachment struct {
	// ID: UUID of the attachment.
	ID string `json:"id"`

	// FilesystemID: UUID of the filesystem.
	FilesystemID string `json:"filesystem_id"`

	// ResourceID: UUID of the attached resource.
	ResourceID string `json:"resource_id"`

	// ResourceType: the type of the attached resource.
	// Default value: unknown_resource_type
	ResourceType AttachmentResourceType `json:"resource_type"`

	// Zone: the zone where the resource is located.
	Zone *scw.Zone `json:"zone"`
}

type AttachmentResourceType string

type CreateFileSystemRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// Name: name of the filesystem.
	Name string `json:"name"`

	// ProjectID: UUID of the project the filesystem belongs to.
	ProjectID string `json:"project_id"`

	// Size: must be compliant with the minimum (100 GB) and maximum (10 TB) allowed size.
	Size uint64 `json:"size"`

	// Tags: list of tags assigned to the filesystem.
	Tags []string `json:"tags"`
}

type DeleteFileSystemRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// FilesystemID: UUID of the filesystem.
	FilesystemID string `json:"-"`
}

type FileSystem struct {
	// ID: UUID of the filesystem.
	ID string `json:"id"`

	// Name: name of the filesystem.
	Name string `json:"name"`

	// Size: filesystem size in bytes.
	Size scw.Size `json:"size"`

	// Status: current status of the filesystem (e.g. creating, available, ...).
	// Default value: unknown_status
	Status FileSystemStatus `json:"status"`

	// ProjectID: UUID of the project to which the filesystem belongs.
	ProjectID string `json:"project_id"`

	// OrganizationID: UUID of the organization to which the filesystem belongs.
	OrganizationID string `json:"organization_id"`

	// Tags: list of tags assigned to the filesystem.
	Tags []string `json:"tags"`

	// NumberOfAttachments: the current number of attachments (mounts) that the filesystem has.
	NumberOfAttachments uint32 `json:"number_of_attachments"`

	// Region: region where the filesystem is located.
	Region scw.Region `json:"region"`

	// CreatedAt: creation date of the filesystem.
	CreatedAt *time.Time `json:"created_at"`

	// UpdatedAt: last update date of the properties of the filesystem.
	UpdatedAt *time.Time `json:"updated_at"`
}

type FileSystemStatus string

type GetFileSystemRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// FilesystemID: UUID of the filesystem.
	FilesystemID string `json:"-"`
}

type ListAttachmentsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// FilesystemID: UUID of the File Storage volume.
	FilesystemID *string `json:"-"`

	// ResourceID: filter by resource ID.
	ResourceID *string `json:"-"`

	// ResourceType: filter by resource type.
	// Default value: unknown_resource_type
	ResourceType AttachmentResourceType `json:"-"`

	// Zone: filter by resource zone.
	Zone *scw.Zone `json:"-"`

	// Page: page number (starting at 1).
	Page *int32 `json:"-"`

	// PageSize: number of entries per page (default: 20, max: 100).
	PageSize *uint32 `json:"-"`
}

type ListAttachmentsResponse struct {
	// Attachments: list of filesystem attachments matching the request criteria.
	Attachments []*Attachment `json:"attachments"`

	// TotalCount: total number of filesystem attachments matching the criteria.
	TotalCount uint64 `json:"total_count"`
}

type ListFileSystemsRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// OrderBy: criteria to use when ordering the list.
	// Default value: created_at_asc
	OrderBy ListFileSystemsRequestOrderBy `json:"-"`

	// ProjectID: filter by project ID.
	ProjectID *string `json:"-"`

	// OrganizationID: filter by organization ID.
	OrganizationID *string `json:"-"`

	// Page: page number (starting at 1).
	Page *int32 `json:"-"`

	// PageSize: number of entries per page (default: 20, max: 100).
	PageSize *uint32 `json:"-"`

	// Name: filter the returned filesystems by their names.
	Name *string `json:"-"`

	// Tags: filter by tags. Only filesystems with one or more matching tags will be returned.
	Tags []string `json:"-"`
}

type ListFileSystemsRequestOrderBy string

type ListFileSystemsResponse struct {
	// Filesystems: list of filesystems matching the request criteria.
	Filesystems []*FileSystem `json:"filesystems"`

	// TotalCount: total number of filesystems matching the criteria.
	TotalCount uint64 `json:"total_count"`
}

type UpdateFileSystemRequest struct {
	// Region: region to target. If none is passed will use default region from the config.
	Region scw.Region `json:"-"`

	// FilesystemID: UUID of the filesystem.
	FilesystemID string `json:"-"`

	// Name: when defined, is the new name of the filesystem.
	Name *string `json:"name,omitempty"`

	// Size: size in bytes, with a granularity of 100 GB (10^11 bytes).
	// Must be compliant with the minimum (100 GB) and maximum (10 TB) allowed size.
	Size *uint64 `json:"size,omitempty"`

	// Tags: list of tags assigned to the filesystem.
	Tags *[]string `json:"tags,omitempty"`
}

type WaitForFileSystemRequest struct {
	FileSystemID  string
	Region        scw.Region
	Timeout       *time.Duration
	RetryInterval *time.Duration
}