scaleway.file.v1alpha1 package

Submodules

scaleway.file.v1alpha1.api module

class scaleway.file.v1alpha1.api.FileV1Alpha1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your File Storage resources.

create_file_system(*, name: str, size: int, region: str | None = None, project_id: str | None = None, tags: List[str] | None = None) → FileSystem

Create a new filesystem. To create a new filesystem, you must specify a name, a size, and a project ID. :param name: Name of the filesystem. :param size: Must be compliant with the minimum (100 GB) and maximum (10 TB) allowed size. :param region: Region to target. If none is passed will use default region from the config. :param project_id: UUID of the project the filesystem belongs to. :param tags: List of tags assigned to the filesystem. :return: FileSystem

Usage:

result = api.create_file_system(
    name="example",
    size=1,
)

delete_file_system(*, filesystem_id: str, region: str | None = None) → None

Delete a detached filesystem. You must specify the filesystem_id of the filesystem you want to delete. :param filesystem_id: UUID of the filesystem. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_file_system(
    filesystem_id="example",
)

get_file_system(*, filesystem_id: str, region: str | None = None) → FileSystem

Get filesystem details. Retrieve all properties and current status of a specific filesystem identified by its ID. :param filesystem_id: UUID of the filesystem. :param region: Region to target. If none is passed will use default region from the config. :return: FileSystem

Usage:

result = api.get_file_system(
    filesystem_id="example",
)

List filesystems attachments. List all existing attachments in a specified region. By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param filesystem_id: UUID of the File Storage volume. :param resource_id: Filter by resource ID. :param resource_type: Filter by resource type. :param zone: Filter by resource zone. :param page: Page number (starting at 1). :param page_size: Number of entries per page (default: 20, max: 100). :return: ListAttachmentsResponse

Usage:

result = api.list_attachments()

List filesystems attachments. List all existing attachments in a specified region. By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param filesystem_id: UUID of the File Storage volume. :param resource_id: Filter by resource ID. :param resource_type: Filter by resource type. :param zone: Filter by resource zone. :param page: Page number (starting at 1). :param page_size: Number of entries per page (default: 20, max: 100). :return: List[Attachment]

Usage:

result = api.list_attachments_all()

List all filesystems. Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Criteria to use when ordering the list. :param project_id: Filter by project ID. :param organization_id: Filter by organization ID. :param page: Page number (starting at 1). :param page_size: Number of entries per page (default: 20, max: 100). :param name: Filter the returned filesystems by their names. :param tags: Filter by tags. Only filesystems with one or more matching tags will be returned. :return: ListFileSystemsResponse

Usage:

result = api.list_file_systems()

List all filesystems. Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Criteria to use when ordering the list. :param project_id: Filter by project ID. :param organization_id: Filter by organization ID. :param page: Page number (starting at 1). :param page_size: Number of entries per page (default: 20, max: 100). :param name: Filter the returned filesystems by their names. :param tags: Filter by tags. Only filesystems with one or more matching tags will be returned. :return: List[FileSystem]

Usage:

result = api.list_file_systems_all()

update_file_system(*, filesystem_id: str, region: str | None = None, name: str | None = None, size: int | None = None, tags: List[str] | None = None) → FileSystem

Update filesystem properties. Update the technical details of a filesystem, such as its name, tags or its new size. :param filesystem_id: UUID of the filesystem. :param region: Region to target. If none is passed will use default region from the config. :param name: When defined, is the new name of the filesystem. :param 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. :param tags: List of tags assigned to the filesystem. :return: FileSystem

Usage:

result = api.update_file_system(
    filesystem_id="example",
)

wait_for_file_system(*, filesystem_id: str, region: str | None = None, options: WaitForOptions[FileSystem, bool] | None = None) → FileSystem

Get filesystem details. Retrieve all properties and current status of a specific filesystem identified by its ID. :param filesystem_id: UUID of the filesystem. :param region: Region to target. If none is passed will use default region from the config. :return: FileSystem

Usage:

result = api.get_file_system(
    filesystem_id="example",
)

scaleway.file.v1alpha1.content module

scaleway.file.v1alpha1.content.FILE_SYSTEM_TRANSIENT_STATUSES: List[FileSystemStatus] = [<FileSystemStatus.CREATING: 'creating'>, <FileSystemStatus.UPDATING: 'updating'>]: Lists transient statutes of the enum FileSystemStatus.

scaleway.file.v1alpha1.marshalling module

scaleway.file.v1alpha1.marshalling.marshal_CreateFileSystemRequest(request: CreateFileSystemRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.file.v1alpha1.marshalling.marshal_UpdateFileSystemRequest(request: UpdateFileSystemRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway.file.v1alpha1.marshalling.unmarshal_Attachment(data: Any) → Attachment

scaleway.file.v1alpha1.marshalling.unmarshal_FileSystem(data: Any) → FileSystem

scaleway.file.v1alpha1.marshalling.unmarshal_ListAttachmentsResponse(data: Any) → ListAttachmentsResponse

scaleway.file.v1alpha1.marshalling.unmarshal_ListFileSystemsResponse(data: Any) → ListFileSystemsResponse

scaleway.file.v1alpha1.types module

class scaleway.file.v1alpha1.types.Attachment(id: str, filesystem_id: str, resource_id: str, resource_type: AttachmentResourceType, zone: str | None = None)

Bases: object

Represents an attachment between a filesystem and a resource.

filesystem_id: str: UUID of the filesystem.

id: str: UUID of the attachment.

resource_id: str: UUID of the attached resource.

resource_type: AttachmentResourceType: The type of the attached resource.

zone: str | None = None: The zone where the resource is located.

class scaleway.file.v1alpha1.types.AttachmentResourceType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

INSTANCE_SERVER = 'instance_server'

UNKNOWN_RESOURCE_TYPE = 'unknown_resource_type'

class scaleway.file.v1alpha1.types.CreateFileSystemRequest(name: str, size: int, region: str | None = None, project_id: str | None = None, tags: ~typing.List[str] | None = <factory>)

Bases: object

Request to create a new filesystem.

name: str: Name of the filesystem.

project_id: str | None = None: UUID of the project the filesystem belongs to.

region: str | None = None: Region to target. If none is passed will use default region from the config.

size: int: Must be compliant with the minimum (100 GB) and maximum (10 TB) allowed size.

tags: List[str] | None: List of tags assigned to the filesystem.

class scaleway.file.v1alpha1.types.DeleteFileSystemRequest(filesystem_id: str, region: str | None = None)

Bases: object

Request to delete a specific filesystem.

filesystem_id: str: UUID of the filesystem.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.file.v1alpha1.types.FileSystem(id: str, name: str, size: int, status: FileSystemStatus, project_id: str, organization_id: str, tags: List[str], number_of_attachments: int, region: str, created_at: datetime | None = None, updated_at: datetime | None = None)

Bases: object

Represents a filesystem resource and its properties.

created_at: datetime | None = None: Creation date of the filesystem.

id: str: UUID of the filesystem.

name: str: Name of the filesystem.

number_of_attachments: int: The current number of attachments (mounts) that the filesystem has.

organization_id: str: UUID of the organization to which the filesystem belongs.

project_id: str: UUID of the project to which the filesystem belongs.

region: str: Region where the filesystem is located.

size: int: Filesystem size in bytes.

status: FileSystemStatus: Current status of the filesystem (e.g. creating, available, …).

tags: List[str]: List of tags assigned to the filesystem.

updated_at: datetime | None = None: Last update date of the properties of the filesystem.

class scaleway.file.v1alpha1.types.FileSystemStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

AVAILABLE = 'available'

CREATING = 'creating'

ERROR = 'error'

UNKNOWN_STATUS = 'unknown_status'

UPDATING = 'updating'

class scaleway.file.v1alpha1.types.GetFileSystemRequest(filesystem_id: str, region: str | None = None)

Bases: object

Request to retrieve a specific filesystem.

filesystem_id: str: UUID of the filesystem.

region: str | None = None: Region to target. If none is passed will use default region from the config.

Bases: object

Request to list filesystem attachments with filtering and pagination options.

filesystem_id: str | None = None: UUID of the File Storage volume.

page: int | None = 0: Page number (starting at 1).

page_size: int | None = 0: Number of entries per page (default: 20, max: 100).

region: str | None = None: Region to target. If none is passed will use default region from the config.

resource_id: str | None = None: Filter by resource ID.

resource_type: AttachmentResourceType | None = 'unknown_resource_type': Filter by resource type.

zone: str | None = None: Filter by resource zone.

class scaleway.file.v1alpha1.types.ListAttachmentsResponse(attachments: List[Attachment], total_count: int)

Bases: object

Response containing a list of filesystem attachments and total count.

attachments: List[Attachment]: List of filesystem attachments matching the request criteria.

total_count: int: Total number of filesystem attachments matching the criteria.

class scaleway.file.v1alpha1.types.ListFileSystemsRequest(region: str | None = None, order_by: ~scaleway.file.v1alpha1.types.ListFileSystemsRequestOrderBy | None = ListFileSystemsRequestOrderBy.CREATED_AT_ASC, project_id: str | None = None, organization_id: str | None = None, page: int | None = 0, page_size: int | None = 0, name: str | None = None, tags: ~typing.List[str] | None = <factory>)

Bases: object

Request to list filesystems with filtering and pagination options.

name: str | None = None: Filter the returned filesystems by their names.

order_by: ListFileSystemsRequestOrderBy | None = 'created_at_asc': Criteria to use when ordering the list.

organization_id: str | None = None: Filter by organization ID.

page: int | None = 0: Page number (starting at 1).

page_size: int | None = 0: Number of entries per page (default: 20, max: 100).

project_id: str | None = None: Filter by project ID.

region: str | None = None: Region to target. If none is passed will use default region from the config.

tags: List[str] | None: Filter by tags. Only filesystems with one or more matching tags will be returned.

class scaleway.file.v1alpha1.types.ListFileSystemsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.file.v1alpha1.types.ListFileSystemsResponse(filesystems: List[FileSystem], total_count: int)

Bases: object

Response containing a list of filesystems and total count.

filesystems: List[FileSystem]: List of filesystems matching the request criteria.

total_count: int: Total number of filesystems matching the criteria.

class scaleway.file.v1alpha1.types.UpdateFileSystemRequest(filesystem_id: str, region: str | None = None, name: str | None = None, size: int | None = 0, tags: ~typing.List[str] | None = <factory>)

Bases: object

Request to update a specific filesystem.

filesystem_id: str: UUID of the filesystem.

name: str | None = None: When defined, is the new name of the filesystem.

region: str | None = None: Region to target. If none is passed will use default region from the config.

size: int | None = 0: 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.

tags: List[str] | None: List of tags assigned to the filesystem.

Module contents

class scaleway.file.v1alpha1.Attachment(id: str, filesystem_id: str, resource_id: str, resource_type: AttachmentResourceType, zone: str | None = None)

Bases: object

Represents an attachment between a filesystem and a resource.

filesystem_id: str: UUID of the filesystem.

id: str: UUID of the attachment.

resource_id: str: UUID of the attached resource.

resource_type: AttachmentResourceType: The type of the attached resource.

zone: str | None = None: The zone where the resource is located.

class scaleway.file.v1alpha1.AttachmentResourceType(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

INSTANCE_SERVER = 'instance_server'

UNKNOWN_RESOURCE_TYPE = 'unknown_resource_type'

class scaleway.file.v1alpha1.CreateFileSystemRequest(name: str, size: int, region: str | None = None, project_id: str | None = None, tags: ~typing.List[str] | None = <factory>)

Bases: object

Request to create a new filesystem.

name: str: Name of the filesystem.

project_id: str | None = None: UUID of the project the filesystem belongs to.

region: str | None = None: Region to target. If none is passed will use default region from the config.

size: int: Must be compliant with the minimum (100 GB) and maximum (10 TB) allowed size.

tags: List[str] | None: List of tags assigned to the filesystem.

class scaleway.file.v1alpha1.DeleteFileSystemRequest(filesystem_id: str, region: str | None = None)

Bases: object

Request to delete a specific filesystem.

filesystem_id: str: UUID of the filesystem.

region: str | None = None: Region to target. If none is passed will use default region from the config.

class scaleway.file.v1alpha1.FileSystem(id: str, name: str, size: int, status: FileSystemStatus, project_id: str, organization_id: str, tags: List[str], number_of_attachments: int, region: str, created_at: datetime | None = None, updated_at: datetime | None = None)

Bases: object

Represents a filesystem resource and its properties.

created_at: datetime | None = None: Creation date of the filesystem.

id: str: UUID of the filesystem.

name: str: Name of the filesystem.

number_of_attachments: int: The current number of attachments (mounts) that the filesystem has.

organization_id: str: UUID of the organization to which the filesystem belongs.

project_id: str: UUID of the project to which the filesystem belongs.

region: str: Region where the filesystem is located.

size: int: Filesystem size in bytes.

status: FileSystemStatus: Current status of the filesystem (e.g. creating, available, …).

tags: List[str]: List of tags assigned to the filesystem.

updated_at: datetime | None = None: Last update date of the properties of the filesystem.

class scaleway.file.v1alpha1.FileSystemStatus(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

AVAILABLE = 'available'

CREATING = 'creating'

ERROR = 'error'

UNKNOWN_STATUS = 'unknown_status'

UPDATING = 'updating'

class scaleway.file.v1alpha1.FileV1Alpha1API(client: Client, *, bypass_validation: bool = False)

Bases: API

This API allows you to manage your File Storage resources.

create_file_system(*, name: str, size: int, region: str | None = None, project_id: str | None = None, tags: List[str] | None = None) → FileSystem

Create a new filesystem. To create a new filesystem, you must specify a name, a size, and a project ID. :param name: Name of the filesystem. :param size: Must be compliant with the minimum (100 GB) and maximum (10 TB) allowed size. :param region: Region to target. If none is passed will use default region from the config. :param project_id: UUID of the project the filesystem belongs to. :param tags: List of tags assigned to the filesystem. :return: FileSystem

Usage:

result = api.create_file_system(
    name="example",
    size=1,
)

delete_file_system(*, filesystem_id: str, region: str | None = None) → None

Delete a detached filesystem. You must specify the filesystem_id of the filesystem you want to delete. :param filesystem_id: UUID of the filesystem. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = api.delete_file_system(
    filesystem_id="example",
)

get_file_system(*, filesystem_id: str, region: str | None = None) → FileSystem

Get filesystem details. Retrieve all properties and current status of a specific filesystem identified by its ID. :param filesystem_id: UUID of the filesystem. :param region: Region to target. If none is passed will use default region from the config. :return: FileSystem

Usage:

result = api.get_file_system(
    filesystem_id="example",
)

List filesystems attachments. List all existing attachments in a specified region. By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param filesystem_id: UUID of the File Storage volume. :param resource_id: Filter by resource ID. :param resource_type: Filter by resource type. :param zone: Filter by resource zone. :param page: Page number (starting at 1). :param page_size: Number of entries per page (default: 20, max: 100). :return: ListAttachmentsResponse

Usage:

result = api.list_attachments()

List filesystems attachments. List all existing attachments in a specified region. By default, the attachments listed are ordered by creation date in ascending order. This can be modified using the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param filesystem_id: UUID of the File Storage volume. :param resource_id: Filter by resource ID. :param resource_type: Filter by resource type. :param zone: Filter by resource zone. :param page: Page number (starting at 1). :param page_size: Number of entries per page (default: 20, max: 100). :return: List[Attachment]

Usage:

result = api.list_attachments_all()

List all filesystems. Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Criteria to use when ordering the list. :param project_id: Filter by project ID. :param organization_id: Filter by organization ID. :param page: Page number (starting at 1). :param page_size: Number of entries per page (default: 20, max: 100). :param name: Filter the returned filesystems by their names. :param tags: Filter by tags. Only filesystems with one or more matching tags will be returned. :return: ListFileSystemsResponse

Usage:

result = api.list_file_systems()

List all filesystems. Retrieve all filesystems in the specified region. By default, the filesystems listed are ordered by creation date in ascending order. This can be modified using the order_by field. :param region: Region to target. If none is passed will use default region from the config. :param order_by: Criteria to use when ordering the list. :param project_id: Filter by project ID. :param organization_id: Filter by organization ID. :param page: Page number (starting at 1). :param page_size: Number of entries per page (default: 20, max: 100). :param name: Filter the returned filesystems by their names. :param tags: Filter by tags. Only filesystems with one or more matching tags will be returned. :return: List[FileSystem]

Usage:

result = api.list_file_systems_all()

update_file_system(*, filesystem_id: str, region: str | None = None, name: str | None = None, size: int | None = None, tags: List[str] | None = None) → FileSystem

Update filesystem properties. Update the technical details of a filesystem, such as its name, tags or its new size. :param filesystem_id: UUID of the filesystem. :param region: Region to target. If none is passed will use default region from the config. :param name: When defined, is the new name of the filesystem. :param 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. :param tags: List of tags assigned to the filesystem. :return: FileSystem

Usage:

result = api.update_file_system(
    filesystem_id="example",
)

wait_for_file_system(*, filesystem_id: str, region: str | None = None, options: WaitForOptions[FileSystem, bool] | None = None) → FileSystem

Get filesystem details. Retrieve all properties and current status of a specific filesystem identified by its ID. :param filesystem_id: UUID of the filesystem. :param region: Region to target. If none is passed will use default region from the config. :return: FileSystem

Usage:

result = api.get_file_system(
    filesystem_id="example",
)

class scaleway.file.v1alpha1.GetFileSystemRequest(filesystem_id: str, region: str | None = None)

Bases: object

Request to retrieve a specific filesystem.

filesystem_id: str: UUID of the filesystem.

region: str | None = None: Region to target. If none is passed will use default region from the config.

Bases: object

Request to list filesystem attachments with filtering and pagination options.

filesystem_id: str | None = None: UUID of the File Storage volume.

page: int | None = 0: Page number (starting at 1).

page_size: int | None = 0: Number of entries per page (default: 20, max: 100).

region: str | None = None: Region to target. If none is passed will use default region from the config.

resource_id: str | None = None: Filter by resource ID.

resource_type: AttachmentResourceType | None = 'unknown_resource_type': Filter by resource type.

zone: str | None = None: Filter by resource zone.

class scaleway.file.v1alpha1.ListAttachmentsResponse(attachments: List[Attachment], total_count: int)

Bases: object

Response containing a list of filesystem attachments and total count.

attachments: List[Attachment]: List of filesystem attachments matching the request criteria.

total_count: int: Total number of filesystem attachments matching the criteria.

class scaleway.file.v1alpha1.ListFileSystemsRequest(region: str | None = None, order_by: ~scaleway.file.v1alpha1.types.ListFileSystemsRequestOrderBy | None = ListFileSystemsRequestOrderBy.CREATED_AT_ASC, project_id: str | None = None, organization_id: str | None = None, page: int | None = 0, page_size: int | None = 0, name: str | None = None, tags: ~typing.List[str] | None = <factory>)

Bases: object

Request to list filesystems with filtering and pagination options.

name: str | None = None: Filter the returned filesystems by their names.

order_by: ListFileSystemsRequestOrderBy | None = 'created_at_asc': Criteria to use when ordering the list.

organization_id: str | None = None: Filter by organization ID.

page: int | None = 0: Page number (starting at 1).

page_size: int | None = 0: Number of entries per page (default: 20, max: 100).

project_id: str | None = None: Filter by project ID.

region: str | None = None: Region to target. If none is passed will use default region from the config.

tags: List[str] | None: Filter by tags. Only filesystems with one or more matching tags will be returned.

class scaleway.file.v1alpha1.ListFileSystemsRequestOrderBy(value: str, names: Any | None = None, *args: Any, **kwargs: Any)

Bases: str, Enum

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

NAME_ASC = 'name_asc'

NAME_DESC = 'name_desc'

class scaleway.file.v1alpha1.ListFileSystemsResponse(filesystems: List[FileSystem], total_count: int)

Bases: object

Response containing a list of filesystems and total count.

filesystems: List[FileSystem]: List of filesystems matching the request criteria.

total_count: int: Total number of filesystems matching the criteria.

class scaleway.file.v1alpha1.UpdateFileSystemRequest(filesystem_id: str, region: str | None = None, name: str | None = None, size: int | None = 0, tags: ~typing.List[str] | None = <factory>)

Bases: object

Request to update a specific filesystem.

filesystem_id: str: UUID of the filesystem.

name: str | None = None: When defined, is the new name of the filesystem.

region: str | None = None: Region to target. If none is passed will use default region from the config.

size: int | None = 0: 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.

tags: List[str] | None: List of tags assigned to the filesystem.