scaleway_async.ipfs.v1alpha1 package

Submodules

scaleway_async.ipfs.v1alpha1.api module

class scaleway_async.ipfs.v1alpha1.api.IpfsV1Alpha1API(client: Client, *, bypass_validation: bool = False)

Bases: API

IPFS Pinning service API.

async create_pin_by_cid(*, volume_id: str, cid: str, region: Optional[str] = None, origins: Optional[List[str]] = None, name: Optional[str] = None) → Pin

Create a pin by CID. Will fetch and store the content pointed by the provided CID. The content must be available on the public IPFS network. The content (IPFS blocks) will be host by the pinning service until pin deletion. From that point, any other IPFS peer can fetch and host your content: Make sure to pin public or encrypted content. Many pin requests (from different users) can target the same CID. A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed) and target CID. :param volume_id: Volume ID on which you want to pin your content. :param cid: CID containing the content you want to pin. :param region: Region to target. If none is passed will use default region from the config. :param origins: Node containing the content you want to pin. :param name: Pin name. :return: Pin

Usage:

result = await api.create_pin_by_cid(
    volume_id="example",
    cid="example",
)

async create_pin_by_url(*, volume_id: str, url: str, region: Optional[str] = None, name: Optional[str] = None) → Pin

Create a pin by URL. Will fetch and store the content pointed by the provided URL. The content must be available on the public IPFS network. The content (IPFS blocks) will be host by the pinning service until pin deletion. From that point, any other IPFS peer can fetch and host your content: Make sure to pin public or encrypted content. Many pin requests (from different users) can target the same CID. A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed) and target CID. :param volume_id: Volume ID on which you want to pin your content. :param url: URL containing the content you want to pin. :param region: Region to target. If none is passed will use default region from the config. :param name: Pin name. :return: Pin

Usage:

result = await api.create_pin_by_url(
    volume_id="example",
    url="example",
)

async create_volume(*, name: str, region: Optional[str] = None, project_id: Optional[str] = None) → Volume

Create a new volume. Create a new volume from a Project ID. Volume is identified by an ID and used to host pin references. Volume is personal (at least to your organization) even if IPFS blocks and CID are available to anyone. Should be the first command you made because every pin must be attached to a volume. :param name: Volume name. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID. :return: Volume

Usage:

result = await api.create_volume(
    name="example",
)

async delete_pin(*, volume_id: str, pin_id: str, region: Optional[str] = None) → None

Create an unpin request. An unpin request means that you no longer own the content. This content can therefore be removed and no longer provided on the IPFS network. :param volume_id: Volume ID. :param pin_id: Pin ID you want to remove from the volume. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = await api.delete_pin(
    volume_id="example",
    pin_id="example",
)

async delete_volume(*, volume_id: str, region: Optional[str] = None) → None

Delete an existing volume. Delete a volume by its ID and every pin attached to this volume. This process can take a while to conclude, depending on the size of your pinned content. :param volume_id: Volume ID. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = await api.delete_volume(
    volume_id="example",
)

async get_pin(*, volume_id: str, pin_id: str, region: Optional[str] = None) → Pin

Get pin information. Retrieve information about the provided pin ID, such as status, last modification, and CID. :param volume_id: Volume ID. :param pin_id: Pin ID of which you want to obtain information. :param region: Region to target. If none is passed will use default region from the config. :return: Pin

Usage:

result = await api.get_pin(
    volume_id="example",
    pin_id="example",
)

async get_volume(*, volume_id: str, region: Optional[str] = None) → Volume

Get information about a volume. Retrieve information about a specific volume. :param volume_id: Volume ID. :param region: Region to target. If none is passed will use default region from the config. :return: Volume

Usage:

result = await api.get_volume(
    volume_id="example",
)

async list_pins(*, volume_id: str, region: Optional[str] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, order_by: Optional[ListPinsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, status: Optional[PinStatus] = None) → ListPinsResponse

List all pins within a volume. Retrieve information about all pins within a volume. :param volume_id: Volume ID of which you want to list the pins. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID. :param organization_id: Organization ID. :param order_by: Sort order of the returned Volume. :param page: Page number. :param page_size: Maximum number of volumes to return per page. :param status: List pins by status. :return: ListPinsResponse

Usage:

result = await api.list_pins(
    volume_id="example",
)

async list_pins_all(*, volume_id: str, region: Optional[str] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, order_by: Optional[ListPinsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, status: Optional[PinStatus] = None) → List[Pin]

List all pins within a volume. Retrieve information about all pins within a volume. :param volume_id: Volume ID of which you want to list the pins. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID. :param organization_id: Organization ID. :param order_by: Sort order of the returned Volume. :param page: Page number. :param page_size: Maximum number of volumes to return per page. :param status: List pins by status. :return: List[Pin]

Usage:

result = await api.list_pins_all(
    volume_id="example",
)

async list_volumes(*, region: Optional[str] = None, project_id: Optional[str] = None, order_by: Optional[ListVolumesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListVolumesResponse

List all volumes by a Project ID. Retrieve information about all volumes from a Project ID. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID, only volumes belonging to this project will be listed. :param order_by: Sort the order of the returned volumes. :param page: Page number. :param page_size: Maximum number of volumes to return per page. :return: ListVolumesResponse

Usage:

result = await api.list_volumes()

async list_volumes_all(*, region: Optional[str] = None, project_id: Optional[str] = None, order_by: Optional[ListVolumesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[Volume]

List all volumes by a Project ID. Retrieve information about all volumes from a Project ID. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID, only volumes belonging to this project will be listed. :param order_by: Sort the order of the returned volumes. :param page: Page number. :param page_size: Maximum number of volumes to return per page. :return: List[Volume]

Usage:

result = await api.list_volumes_all()

async replace_pin(*, volume_id: str, pin_id: str, cid: str, region: Optional[str] = None, name: Optional[str] = None, origins: Optional[List[str]] = None) → ReplacePinResponse

Replace pin by CID. Deletes the given resource ID and pins the new CID in its place. Will fetch and store the content pointed by the provided CID. The content must be available on the public IPFS network. The content (IPFS blocks) is hosted by the pinning service until the pin is deleted. While the content is available any other IPFS peer can fetch and host your content. For this reason, we recommend that you pin either public or encrypted content. Several different pin requests can target the same CID. A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed) and target CID. :param volume_id: Volume ID. :param pin_id: Pin ID whose information you wish to replace. :param cid: New CID you want to pin in place of the old one. :param region: Region to target. If none is passed will use default region from the config. :param name: New name to replace. :param origins: Node containing the content you want to pin. :return: ReplacePinResponse

Usage:

result = await api.replace_pin(
    volume_id="example",
    pin_id="example",
    cid="example",
)

async update_volume(*, volume_id: str, region: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None) → Volume

Update volume information. Update volume information (tag, name…). :param volume_id: Volume ID. :param region: Region to target. If none is passed will use default region from the config. :param name: Volume name. :param tags: Tags of the volume. :return: Volume

Usage:

result = await api.update_volume(
    volume_id="example",
)

async wait_for_pin(*, volume_id: str, pin_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[Pin, Union[bool, Awaitable[bool]]]] = None) → Pin

Get pin information. Retrieve information about the provided pin ID, such as status, last modification, and CID. :param volume_id: Volume ID. :param pin_id: Pin ID of which you want to obtain information. :param region: Region to target. If none is passed will use default region from the config. :return: Pin

Usage:

result = await api.get_pin(
    volume_id="example",
    pin_id="example",
)

class scaleway_async.ipfs.v1alpha1.api.IpfsV1Alpha1IpnsAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

async create_name(*, name: str, value: str, region: Optional[str] = None, project_id: Optional[str] = None) → Name

Create a new name. You can use the ipns key command to list and generate more names and their respective keys. :param name: Name for your records. :param value: Value you want to associate with your records, CID or IPNS key. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID. :return: Name

Usage:

result = await api.create_name(
    name="example",
    value="example",
)

async delete_name(*, name_id: str, region: Optional[str] = None) → None

Delete an existing name. Delete a name by its ID. :param name_id: Name ID you wish to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = await api.delete_name(
    name_id="example",
)

async export_key_name(*, name_id: str, region: Optional[str] = None) → ExportKeyNameResponse

Export your private key. Export a private key by its ID. :param name_id: Name ID whose keys you want to export. :param region: Region to target. If none is passed will use default region from the config. :return: ExportKeyNameResponse

Usage:

result = await api.export_key_name(
    name_id="example",
)

async get_name(*, name_id: str, region: Optional[str] = None) → Name

Get information about a name. Retrieve information about a specific name. :param name_id: Name ID whose information you want to retrieve. :param region: Region to target. If none is passed will use default region from the config. :return: Name

Usage:

result = await api.get_name(
    name_id="example",
)

async import_key_name(*, name: str, private_key: str, value: str, region: Optional[str] = None, project_id: Optional[str] = None) → Name

Import your private key. Import a private key. :param name: Name for your records. :param private_key: Base64 private key. :param value: Value you want to associate with your records, CID or IPNS key. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID. :return: Name

Usage:

result = await api.import_key_name(
    name="example",
    private_key="example",
    value="example",
)

async list_names(*, region: Optional[str] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, order_by: Optional[ListNamesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListNamesResponse

List all names by a Project ID. Retrieve information about all names from a Project ID. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID. :param organization_id: Organization ID. :param order_by: Sort the order of the returned names. :param page: Page number. :param page_size: Maximum number of names to return per page. :return: ListNamesResponse

Usage:

result = await api.list_names()

async list_names_all(*, region: Optional[str] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, order_by: Optional[ListNamesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[Name]

List all names by a Project ID. Retrieve information about all names from a Project ID. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID. :param organization_id: Organization ID. :param order_by: Sort the order of the returned names. :param page: Page number. :param page_size: Maximum number of names to return per page. :return: List[Name]

Usage:

result = await api.list_names_all()

async update_name(*, name_id: str, region: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, value: Optional[str] = None) → Name

Update name information. Update name information (CID, tag, name…). :param name_id: Name ID you wish to update. :param region: Region to target. If none is passed will use default region from the config. :param name: New name you want to associate with your record. :param tags: New tags you want to associate with your record. :param value: Value you want to associate with your records, CID or IPNS key. :return: Name

Usage:

result = await api.update_name(
    name_id="example",
)

async wait_for_name(*, name_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[Name, Union[bool, Awaitable[bool]]]] = None) → Name

Get information about a name. Retrieve information about a specific name. :param name_id: Name ID whose information you want to retrieve. :param region: Region to target. If none is passed will use default region from the config. :return: Name

Usage:

result = await api.get_name(
    name_id="example",
)

scaleway_async.ipfs.v1alpha1.content module

scaleway_async.ipfs.v1alpha1.content.NAME_TRANSIENT_STATUSES: List[NameStatus] = [<NameStatus.QUEUED: 'queued'>, <NameStatus.PUBLISHING: 'publishing'>]: Lists transient statutes of the enum NameStatus.

scaleway_async.ipfs.v1alpha1.content.PIN_TRANSIENT_STATUSES: List[PinStatus] = [<PinStatus.QUEUED: 'queued'>, <PinStatus.PINNING: 'pinning'>]: Lists transient statutes of the enum PinStatus.

scaleway_async.ipfs.v1alpha1.marshalling module

scaleway_async.ipfs.v1alpha1.marshalling.marshal_CreatePinByCIDRequest(request: CreatePinByCIDRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.ipfs.v1alpha1.marshalling.marshal_CreatePinByURLRequest(request: CreatePinByURLRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.ipfs.v1alpha1.marshalling.marshal_CreateVolumeRequest(request: CreateVolumeRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.ipfs.v1alpha1.marshalling.marshal_IpnsApiCreateNameRequest(request: IpnsApiCreateNameRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.ipfs.v1alpha1.marshalling.marshal_IpnsApiImportKeyNameRequest(request: IpnsApiImportKeyNameRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.ipfs.v1alpha1.marshalling.marshal_IpnsApiUpdateNameRequest(request: IpnsApiUpdateNameRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.ipfs.v1alpha1.marshalling.marshal_ReplacePinRequest(request: ReplacePinRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.ipfs.v1alpha1.marshalling.marshal_UpdateVolumeRequest(request: UpdateVolumeRequest, defaults: ProfileDefaults) → Dict[str, Any]

scaleway_async.ipfs.v1alpha1.marshalling.unmarshal_ExportKeyNameResponse(data: Any) → ExportKeyNameResponse

scaleway_async.ipfs.v1alpha1.marshalling.unmarshal_ListNamesResponse(data: Any) → ListNamesResponse

scaleway_async.ipfs.v1alpha1.marshalling.unmarshal_ListPinsResponse(data: Any) → ListPinsResponse

scaleway_async.ipfs.v1alpha1.marshalling.unmarshal_ListVolumesResponse(data: Any) → ListVolumesResponse

scaleway_async.ipfs.v1alpha1.marshalling.unmarshal_Name(data: Any) → Name

scaleway_async.ipfs.v1alpha1.marshalling.unmarshal_Pin(data: Any) → Pin

scaleway_async.ipfs.v1alpha1.marshalling.unmarshal_PinCID(data: Any) → PinCID

scaleway_async.ipfs.v1alpha1.marshalling.unmarshal_PinCIDMeta(data: Any) → PinCIDMeta

scaleway_async.ipfs.v1alpha1.marshalling.unmarshal_PinInfo(data: Any) → PinInfo

scaleway_async.ipfs.v1alpha1.marshalling.unmarshal_ReplacePinResponse(data: Any) → ReplacePinResponse

scaleway_async.ipfs.v1alpha1.marshalling.unmarshal_Volume(data: Any) → Volume

scaleway_async.ipfs.v1alpha1.types module

class scaleway_async.ipfs.v1alpha1.types.CreatePinByCIDRequest(volume_id: 'str', cid: 'str', region: 'Optional[Region]', origins: 'Optional[List[str]]', name: 'Optional[str]')

Bases: object

cid: str: CID containing the content you want to pin.

name: Optional[str]: Pin name.

origins: Optional[List[str]]: Node containing the content you want to pin.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

volume_id: str: Volume ID on which you want to pin your content.

class scaleway_async.ipfs.v1alpha1.types.CreatePinByURLRequest(volume_id: 'str', url: 'str', region: 'Optional[Region]', name: 'Optional[str]')

Bases: object

name: Optional[str]: Pin name.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

url: str: URL containing the content you want to pin.

volume_id: str: Volume ID on which you want to pin your content.

class scaleway_async.ipfs.v1alpha1.types.CreateVolumeRequest(name: 'str', region: 'Optional[Region]', project_id: 'Optional[str]')

Bases: object

name: str: Volume name.

project_id: Optional[str]: Project ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway_async.ipfs.v1alpha1.types.DeletePinRequest(volume_id: 'str', pin_id: 'str', region: 'Optional[Region]')

Bases: object

pin_id: str: Pin ID you want to remove from the volume.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

volume_id: str: Volume ID.

class scaleway_async.ipfs.v1alpha1.types.DeleteVolumeRequest(volume_id: 'str', region: 'Optional[Region]')

Bases: object

region: Optional[str]: Region to target. If none is passed will use default region from the config.

volume_id: str: Volume ID.

class scaleway_async.ipfs.v1alpha1.types.ExportKeyNameResponse(name_id: 'str', project_id: 'str', public_key: 'str', private_key: 'str', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]')

Bases: object

created_at: Optional[datetime]

name_id: str

private_key: str

project_id: str

public_key: str

updated_at: Optional[datetime]

class scaleway_async.ipfs.v1alpha1.types.GetPinRequest(volume_id: 'str', pin_id: 'str', region: 'Optional[Region]')

Bases: object

pin_id: str: Pin ID of which you want to obtain information.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

volume_id: str: Volume ID.

class scaleway_async.ipfs.v1alpha1.types.GetVolumeRequest(volume_id: 'str', region: 'Optional[Region]')

Bases: object

region: Optional[str]: Region to target. If none is passed will use default region from the config.

volume_id: str: Volume ID.

class scaleway_async.ipfs.v1alpha1.types.IpnsApiCreateNameRequest(name: 'str', value: 'str', region: 'Optional[Region]', project_id: 'Optional[str]')

Bases: object

name: str: Name for your records.

project_id: Optional[str]: Project ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

value: str: Value you want to associate with your records, CID or IPNS key.

class scaleway_async.ipfs.v1alpha1.types.IpnsApiDeleteNameRequest(name_id: 'str', region: 'Optional[Region]')

Bases: object

name_id: str: Name ID you wish to delete.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway_async.ipfs.v1alpha1.types.IpnsApiExportKeyNameRequest(name_id: 'str', region: 'Optional[Region]')

Bases: object

name_id: str: Name ID whose keys you want to export.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway_async.ipfs.v1alpha1.types.IpnsApiGetNameRequest(name_id: 'str', region: 'Optional[Region]')

Bases: object

name_id: str: Name ID whose information you want to retrieve.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway_async.ipfs.v1alpha1.types.IpnsApiImportKeyNameRequest(name: 'str', private_key: 'str', value: 'str', region: 'Optional[Region]', project_id: 'Optional[str]')

Bases: object

name: str: Name for your records.

private_key: str: Base64 private key.

project_id: Optional[str]: Project ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

value: str: Value you want to associate with your records, CID or IPNS key.

class scaleway_async.ipfs.v1alpha1.types.IpnsApiListNamesRequest(region: 'Optional[Region]', project_id: 'Optional[str]', organization_id: 'Optional[str]', order_by: 'Optional[ListNamesRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

order_by: Optional[ListNamesRequestOrderBy]: Sort the order of the returned names.

organization_id: Optional[str]: Organization ID.

page: Optional[int]: Page number.

page_size: Optional[int]: Maximum number of names to return per page.

project_id: Optional[str]: Project ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway_async.ipfs.v1alpha1.types.IpnsApiUpdateNameRequest(name_id: 'str', region: 'Optional[Region]', name: 'Optional[str]', tags: 'Optional[List[str]]', value: 'Optional[str]')

Bases: object

name: Optional[str]: New name you want to associate with your record.

name_id: str: Name ID you wish to update.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]: New tags you want to associate with your record.

value: Optional[str]: Value you want to associate with your records, CID or IPNS key.

class scaleway_async.ipfs.v1alpha1.types.ListNamesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway_async.ipfs.v1alpha1.types.ListNamesResponse(names: 'List[Name]', total_count: 'int')

Bases: object

names: List[Name]

total_count: int

class scaleway_async.ipfs.v1alpha1.types.ListPinsRequest(volume_id: 'str', region: 'Optional[Region]', project_id: 'Optional[str]', organization_id: 'Optional[str]', order_by: 'Optional[ListPinsRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', status: 'Optional[PinStatus]')

Bases: object

order_by: Optional[ListPinsRequestOrderBy]: Sort order of the returned Volume.

organization_id: Optional[str]: Organization ID.

page: Optional[int]: Page number.

page_size: Optional[int]: Maximum number of volumes to return per page.

project_id: Optional[str]: Project ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

status: Optional[PinStatus]: List pins by status.

volume_id: str: Volume ID of which you want to list the pins.

class scaleway_async.ipfs.v1alpha1.types.ListPinsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway_async.ipfs.v1alpha1.types.ListPinsResponse(total_count: 'int', pins: 'List[Pin]')

Bases: object

pins: List[Pin]

total_count: int

class scaleway_async.ipfs.v1alpha1.types.ListVolumesRequest(region: 'Optional[Region]', project_id: 'Optional[str]', order_by: 'Optional[ListVolumesRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

order_by: Optional[ListVolumesRequestOrderBy]: Sort the order of the returned volumes.

page: Optional[int]: Page number.

page_size: Optional[int]: Maximum number of volumes to return per page.

project_id: Optional[str]: Project ID, only volumes belonging to this project will be listed.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway_async.ipfs.v1alpha1.types.ListVolumesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway_async.ipfs.v1alpha1.types.ListVolumesResponse(volumes: 'List[Volume]', total_count: 'int')

Bases: object

total_count: int

volumes: List[Volume]

class scaleway_async.ipfs.v1alpha1.types.Name(name_id: 'str', project_id: 'str', tags: 'List[str]', name: 'str', key: 'str', status: 'NameStatus', value: 'str', region: 'Region', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]')

Bases: object

created_at: Optional[datetime]

key: str

name: str

name_id: str

project_id: str

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

status: NameStatus

tags: List[str]

updated_at: Optional[datetime]

value: str

class scaleway_async.ipfs.v1alpha1.types.NameStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

FAILED = 'failed'

PUBLISHED = 'published'

PUBLISHING = 'publishing'

QUEUED = 'queued'

UNKNOWN_STATUS = 'unknown_status'

class scaleway_async.ipfs.v1alpha1.types.Pin(pin_id: 'str', status: 'PinStatus', delegates: 'List[str]', created_at: 'Optional[datetime]', cid: 'Optional[PinCID]', info: 'Optional[PinInfo]')

Bases: object

cid: Optional[PinCID]

created_at: Optional[datetime]

delegates: List[str]

info: Optional[PinInfo]

pin_id: str

status: PinStatus

class scaleway_async.ipfs.v1alpha1.types.PinCID(origins: 'List[str]', cid: 'Optional[str]', name: 'Optional[str]', meta: 'Optional[PinCIDMeta]')

Bases: object

cid: Optional[str]

meta: Optional[PinCIDMeta]

name: Optional[str]

origins: List[str]

class scaleway_async.ipfs.v1alpha1.types.PinCIDMeta(id: 'Optional[str]')

Bases: object

id: Optional[str]

class scaleway_async.ipfs.v1alpha1.types.PinDetails(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CHECKING_COHERENCE = 'checking_coherence'

FAILED_CONTAINS_BANNED_CID = 'failed_contains_banned_cid'

FAILED_PINNING = 'failed_pinning'

FAILED_PINNING_BAD_CID_FORMAT = 'failed_pinning_bad_cid_format'

FAILED_PINNING_BAD_URL_FORMAT = 'failed_pinning_bad_url_format'

FAILED_PINNING_BAD_URL_STATUS_CODE = 'failed_pinning_bad_url_status_code'

FAILED_PINNING_NO_PROVIDER = 'failed_pinning_no_provider'

FAILED_PINNING_NO_URL_CONTENT_LENGTH = 'failed_pinning_no_url_content_length'

FAILED_PINNING_TIMEOUT = 'failed_pinning_timeout'

FAILED_PINNING_TOO_BIG_CONTENT = 'failed_pinning_too_big_content'

FAILED_PINNING_UNREACHABLE_URL = 'failed_pinning_unreachable_url'

FAILED_UNPINNING = 'failed_unpinning'

PINNED_OK = 'pinned_ok'

PINNING_BLOCKS_FETCHED = 'pinning_blocks_fetched'

PINNING_FETCHING_URL_DATA = 'pinning_fetching_url_data'

PINNING_IN_PROGRESS = 'pinning_in_progress'

PINNING_LOOKING_FOR_PROVIDER = 'pinning_looking_for_provider'

RESCHEDULED = 'rescheduled'

UNKNOWN_DETAILS = 'unknown_details'

UNPINNED_OK = 'unpinned_ok'

UNPINNING_IN_PROGRESS = 'unpinning_in_progress'

class scaleway_async.ipfs.v1alpha1.types.PinInfo(status_details: 'PinDetails', id: 'Optional[str]', url: 'Optional[str]', size: 'Optional[int]', progress: 'Optional[int]')

Bases: object

id: Optional[str]

progress: Optional[int]

size: Optional[int]

status_details: PinDetails

url: Optional[str]

class scaleway_async.ipfs.v1alpha1.types.PinStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

FAILED = 'failed'

PINNED = 'pinned'

PINNING = 'pinning'

QUEUED = 'queued'

UNKNOWN_STATUS = 'unknown_status'

class scaleway_async.ipfs.v1alpha1.types.ReplacePinRequest(volume_id: 'str', pin_id: 'str', cid: 'str', region: 'Optional[Region]', name: 'Optional[str]', origins: 'Optional[List[str]]')

Bases: object

cid: str: New CID you want to pin in place of the old one.

name: Optional[str]: New name to replace.

origins: Optional[List[str]]: Node containing the content you want to pin.

pin_id: str: Pin ID whose information you wish to replace.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

volume_id: str: Volume ID.

class scaleway_async.ipfs.v1alpha1.types.ReplacePinResponse(pin: 'Optional[Pin]')

Bases: object

pin: Optional[Pin]

class scaleway_async.ipfs.v1alpha1.types.UpdateVolumeRequest(volume_id: 'str', region: 'Optional[Region]', name: 'Optional[str]', tags: 'Optional[List[str]]')

Bases: object

name: Optional[str]: Volume name.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]: Tags of the volume.

volume_id: str: Volume ID.

class scaleway_async.ipfs.v1alpha1.types.Volume(id: 'str', project_id: 'str', region: 'Region', count_pin: 'int', tags: 'List[str]', name: 'str', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', size: 'Optional[int]')

Bases: object

count_pin: int

created_at: Optional[datetime]

id: str

name: str

project_id: str

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

size: Optional[int]

tags: List[str]

updated_at: Optional[datetime]

Module contents

class scaleway_async.ipfs.v1alpha1.CreatePinByCIDRequest(volume_id: 'str', cid: 'str', region: 'Optional[Region]', origins: 'Optional[List[str]]', name: 'Optional[str]')

Bases: object

cid: str: CID containing the content you want to pin.

name: Optional[str]: Pin name.

origins: Optional[List[str]]: Node containing the content you want to pin.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

volume_id: str: Volume ID on which you want to pin your content.

class scaleway_async.ipfs.v1alpha1.CreatePinByURLRequest(volume_id: 'str', url: 'str', region: 'Optional[Region]', name: 'Optional[str]')

Bases: object

name: Optional[str]: Pin name.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

url: str: URL containing the content you want to pin.

volume_id: str: Volume ID on which you want to pin your content.

class scaleway_async.ipfs.v1alpha1.CreateVolumeRequest(name: 'str', region: 'Optional[Region]', project_id: 'Optional[str]')

Bases: object

name: str: Volume name.

project_id: Optional[str]: Project ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway_async.ipfs.v1alpha1.DeletePinRequest(volume_id: 'str', pin_id: 'str', region: 'Optional[Region]')

Bases: object

pin_id: str: Pin ID you want to remove from the volume.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

volume_id: str: Volume ID.

class scaleway_async.ipfs.v1alpha1.DeleteVolumeRequest(volume_id: 'str', region: 'Optional[Region]')

Bases: object

region: Optional[str]: Region to target. If none is passed will use default region from the config.

volume_id: str: Volume ID.

class scaleway_async.ipfs.v1alpha1.ExportKeyNameResponse(name_id: 'str', project_id: 'str', public_key: 'str', private_key: 'str', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]')

Bases: object

created_at: Optional[datetime]

name_id: str

private_key: str

project_id: str

public_key: str

updated_at: Optional[datetime]

class scaleway_async.ipfs.v1alpha1.GetPinRequest(volume_id: 'str', pin_id: 'str', region: 'Optional[Region]')

Bases: object

pin_id: str: Pin ID of which you want to obtain information.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

volume_id: str: Volume ID.

class scaleway_async.ipfs.v1alpha1.GetVolumeRequest(volume_id: 'str', region: 'Optional[Region]')

Bases: object

region: Optional[str]: Region to target. If none is passed will use default region from the config.

volume_id: str: Volume ID.

class scaleway_async.ipfs.v1alpha1.IpfsV1Alpha1API(client: Client, *, bypass_validation: bool = False)

Bases: API

IPFS Pinning service API.

async create_pin_by_cid(*, volume_id: str, cid: str, region: Optional[str] = None, origins: Optional[List[str]] = None, name: Optional[str] = None) → Pin

Create a pin by CID. Will fetch and store the content pointed by the provided CID. The content must be available on the public IPFS network. The content (IPFS blocks) will be host by the pinning service until pin deletion. From that point, any other IPFS peer can fetch and host your content: Make sure to pin public or encrypted content. Many pin requests (from different users) can target the same CID. A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed) and target CID. :param volume_id: Volume ID on which you want to pin your content. :param cid: CID containing the content you want to pin. :param region: Region to target. If none is passed will use default region from the config. :param origins: Node containing the content you want to pin. :param name: Pin name. :return: Pin

Usage:

result = await api.create_pin_by_cid(
    volume_id="example",
    cid="example",
)

async create_pin_by_url(*, volume_id: str, url: str, region: Optional[str] = None, name: Optional[str] = None) → Pin

Create a pin by URL. Will fetch and store the content pointed by the provided URL. The content must be available on the public IPFS network. The content (IPFS blocks) will be host by the pinning service until pin deletion. From that point, any other IPFS peer can fetch and host your content: Make sure to pin public or encrypted content. Many pin requests (from different users) can target the same CID. A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed) and target CID. :param volume_id: Volume ID on which you want to pin your content. :param url: URL containing the content you want to pin. :param region: Region to target. If none is passed will use default region from the config. :param name: Pin name. :return: Pin

Usage:

result = await api.create_pin_by_url(
    volume_id="example",
    url="example",
)

async create_volume(*, name: str, region: Optional[str] = None, project_id: Optional[str] = None) → Volume

Create a new volume. Create a new volume from a Project ID. Volume is identified by an ID and used to host pin references. Volume is personal (at least to your organization) even if IPFS blocks and CID are available to anyone. Should be the first command you made because every pin must be attached to a volume. :param name: Volume name. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID. :return: Volume

Usage:

result = await api.create_volume(
    name="example",
)

async delete_pin(*, volume_id: str, pin_id: str, region: Optional[str] = None) → None

Create an unpin request. An unpin request means that you no longer own the content. This content can therefore be removed and no longer provided on the IPFS network. :param volume_id: Volume ID. :param pin_id: Pin ID you want to remove from the volume. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = await api.delete_pin(
    volume_id="example",
    pin_id="example",
)

async delete_volume(*, volume_id: str, region: Optional[str] = None) → None

Delete an existing volume. Delete a volume by its ID and every pin attached to this volume. This process can take a while to conclude, depending on the size of your pinned content. :param volume_id: Volume ID. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = await api.delete_volume(
    volume_id="example",
)

async get_pin(*, volume_id: str, pin_id: str, region: Optional[str] = None) → Pin

Get pin information. Retrieve information about the provided pin ID, such as status, last modification, and CID. :param volume_id: Volume ID. :param pin_id: Pin ID of which you want to obtain information. :param region: Region to target. If none is passed will use default region from the config. :return: Pin

Usage:

result = await api.get_pin(
    volume_id="example",
    pin_id="example",
)

async get_volume(*, volume_id: str, region: Optional[str] = None) → Volume

Get information about a volume. Retrieve information about a specific volume. :param volume_id: Volume ID. :param region: Region to target. If none is passed will use default region from the config. :return: Volume

Usage:

result = await api.get_volume(
    volume_id="example",
)

async list_pins(*, volume_id: str, region: Optional[str] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, order_by: Optional[ListPinsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, status: Optional[PinStatus] = None) → ListPinsResponse

List all pins within a volume. Retrieve information about all pins within a volume. :param volume_id: Volume ID of which you want to list the pins. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID. :param organization_id: Organization ID. :param order_by: Sort order of the returned Volume. :param page: Page number. :param page_size: Maximum number of volumes to return per page. :param status: List pins by status. :return: ListPinsResponse

Usage:

result = await api.list_pins(
    volume_id="example",
)

async list_pins_all(*, volume_id: str, region: Optional[str] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, order_by: Optional[ListPinsRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None, status: Optional[PinStatus] = None) → List[Pin]

List all pins within a volume. Retrieve information about all pins within a volume. :param volume_id: Volume ID of which you want to list the pins. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID. :param organization_id: Organization ID. :param order_by: Sort order of the returned Volume. :param page: Page number. :param page_size: Maximum number of volumes to return per page. :param status: List pins by status. :return: List[Pin]

Usage:

result = await api.list_pins_all(
    volume_id="example",
)

async list_volumes(*, region: Optional[str] = None, project_id: Optional[str] = None, order_by: Optional[ListVolumesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListVolumesResponse

List all volumes by a Project ID. Retrieve information about all volumes from a Project ID. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID, only volumes belonging to this project will be listed. :param order_by: Sort the order of the returned volumes. :param page: Page number. :param page_size: Maximum number of volumes to return per page. :return: ListVolumesResponse

Usage:

result = await api.list_volumes()

async list_volumes_all(*, region: Optional[str] = None, project_id: Optional[str] = None, order_by: Optional[ListVolumesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[Volume]

List all volumes by a Project ID. Retrieve information about all volumes from a Project ID. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID, only volumes belonging to this project will be listed. :param order_by: Sort the order of the returned volumes. :param page: Page number. :param page_size: Maximum number of volumes to return per page. :return: List[Volume]

Usage:

result = await api.list_volumes_all()

async replace_pin(*, volume_id: str, pin_id: str, cid: str, region: Optional[str] = None, name: Optional[str] = None, origins: Optional[List[str]] = None) → ReplacePinResponse

Replace pin by CID. Deletes the given resource ID and pins the new CID in its place. Will fetch and store the content pointed by the provided CID. The content must be available on the public IPFS network. The content (IPFS blocks) is hosted by the pinning service until the pin is deleted. While the content is available any other IPFS peer can fetch and host your content. For this reason, we recommend that you pin either public or encrypted content. Several different pin requests can target the same CID. A pin is defined by its ID (UUID), its status (queued, pinning, pinned or failed) and target CID. :param volume_id: Volume ID. :param pin_id: Pin ID whose information you wish to replace. :param cid: New CID you want to pin in place of the old one. :param region: Region to target. If none is passed will use default region from the config. :param name: New name to replace. :param origins: Node containing the content you want to pin. :return: ReplacePinResponse

Usage:

result = await api.replace_pin(
    volume_id="example",
    pin_id="example",
    cid="example",
)

async update_volume(*, volume_id: str, region: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None) → Volume

Update volume information. Update volume information (tag, name…). :param volume_id: Volume ID. :param region: Region to target. If none is passed will use default region from the config. :param name: Volume name. :param tags: Tags of the volume. :return: Volume

Usage:

result = await api.update_volume(
    volume_id="example",
)

async wait_for_pin(*, volume_id: str, pin_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[Pin, Union[bool, Awaitable[bool]]]] = None) → Pin

Get pin information. Retrieve information about the provided pin ID, such as status, last modification, and CID. :param volume_id: Volume ID. :param pin_id: Pin ID of which you want to obtain information. :param region: Region to target. If none is passed will use default region from the config. :return: Pin

Usage:

result = await api.get_pin(
    volume_id="example",
    pin_id="example",
)

class scaleway_async.ipfs.v1alpha1.IpfsV1Alpha1IpnsAPI(client: Client, *, bypass_validation: bool = False)

Bases: API

async create_name(*, name: str, value: str, region: Optional[str] = None, project_id: Optional[str] = None) → Name

Create a new name. You can use the ipns key command to list and generate more names and their respective keys. :param name: Name for your records. :param value: Value you want to associate with your records, CID or IPNS key. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID. :return: Name

Usage:

result = await api.create_name(
    name="example",
    value="example",
)

async delete_name(*, name_id: str, region: Optional[str] = None) → None

Delete an existing name. Delete a name by its ID. :param name_id: Name ID you wish to delete. :param region: Region to target. If none is passed will use default region from the config.

Usage:

result = await api.delete_name(
    name_id="example",
)

async export_key_name(*, name_id: str, region: Optional[str] = None) → ExportKeyNameResponse

Export your private key. Export a private key by its ID. :param name_id: Name ID whose keys you want to export. :param region: Region to target. If none is passed will use default region from the config. :return: ExportKeyNameResponse

Usage:

result = await api.export_key_name(
    name_id="example",
)

async get_name(*, name_id: str, region: Optional[str] = None) → Name

Get information about a name. Retrieve information about a specific name. :param name_id: Name ID whose information you want to retrieve. :param region: Region to target. If none is passed will use default region from the config. :return: Name

Usage:

result = await api.get_name(
    name_id="example",
)

async import_key_name(*, name: str, private_key: str, value: str, region: Optional[str] = None, project_id: Optional[str] = None) → Name

Import your private key. Import a private key. :param name: Name for your records. :param private_key: Base64 private key. :param value: Value you want to associate with your records, CID or IPNS key. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID. :return: Name

Usage:

result = await api.import_key_name(
    name="example",
    private_key="example",
    value="example",
)

async list_names(*, region: Optional[str] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, order_by: Optional[ListNamesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → ListNamesResponse

List all names by a Project ID. Retrieve information about all names from a Project ID. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID. :param organization_id: Organization ID. :param order_by: Sort the order of the returned names. :param page: Page number. :param page_size: Maximum number of names to return per page. :return: ListNamesResponse

Usage:

result = await api.list_names()

async list_names_all(*, region: Optional[str] = None, project_id: Optional[str] = None, organization_id: Optional[str] = None, order_by: Optional[ListNamesRequestOrderBy] = None, page: Optional[int] = None, page_size: Optional[int] = None) → List[Name]

List all names by a Project ID. Retrieve information about all names from a Project ID. :param region: Region to target. If none is passed will use default region from the config. :param project_id: Project ID. :param organization_id: Organization ID. :param order_by: Sort the order of the returned names. :param page: Page number. :param page_size: Maximum number of names to return per page. :return: List[Name]

Usage:

result = await api.list_names_all()

async update_name(*, name_id: str, region: Optional[str] = None, name: Optional[str] = None, tags: Optional[List[str]] = None, value: Optional[str] = None) → Name

Update name information. Update name information (CID, tag, name…). :param name_id: Name ID you wish to update. :param region: Region to target. If none is passed will use default region from the config. :param name: New name you want to associate with your record. :param tags: New tags you want to associate with your record. :param value: Value you want to associate with your records, CID or IPNS key. :return: Name

Usage:

result = await api.update_name(
    name_id="example",
)

async wait_for_name(*, name_id: str, region: Optional[str] = None, options: Optional[WaitForOptions[Name, Union[bool, Awaitable[bool]]]] = None) → Name

Get information about a name. Retrieve information about a specific name. :param name_id: Name ID whose information you want to retrieve. :param region: Region to target. If none is passed will use default region from the config. :return: Name

Usage:

result = await api.get_name(
    name_id="example",
)

class scaleway_async.ipfs.v1alpha1.IpnsApiCreateNameRequest(name: 'str', value: 'str', region: 'Optional[Region]', project_id: 'Optional[str]')

Bases: object

name: str: Name for your records.

project_id: Optional[str]: Project ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

value: str: Value you want to associate with your records, CID or IPNS key.

class scaleway_async.ipfs.v1alpha1.IpnsApiDeleteNameRequest(name_id: 'str', region: 'Optional[Region]')

Bases: object

name_id: str: Name ID you wish to delete.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway_async.ipfs.v1alpha1.IpnsApiExportKeyNameRequest(name_id: 'str', region: 'Optional[Region]')

Bases: object

name_id: str: Name ID whose keys you want to export.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway_async.ipfs.v1alpha1.IpnsApiGetNameRequest(name_id: 'str', region: 'Optional[Region]')

Bases: object

name_id: str: Name ID whose information you want to retrieve.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway_async.ipfs.v1alpha1.IpnsApiImportKeyNameRequest(name: 'str', private_key: 'str', value: 'str', region: 'Optional[Region]', project_id: 'Optional[str]')

Bases: object

name: str: Name for your records.

private_key: str: Base64 private key.

project_id: Optional[str]: Project ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

value: str: Value you want to associate with your records, CID or IPNS key.

class scaleway_async.ipfs.v1alpha1.IpnsApiListNamesRequest(region: 'Optional[Region]', project_id: 'Optional[str]', organization_id: 'Optional[str]', order_by: 'Optional[ListNamesRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

order_by: Optional[ListNamesRequestOrderBy]: Sort the order of the returned names.

organization_id: Optional[str]: Organization ID.

page: Optional[int]: Page number.

page_size: Optional[int]: Maximum number of names to return per page.

project_id: Optional[str]: Project ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway_async.ipfs.v1alpha1.IpnsApiUpdateNameRequest(name_id: 'str', region: 'Optional[Region]', name: 'Optional[str]', tags: 'Optional[List[str]]', value: 'Optional[str]')

Bases: object

name: Optional[str]: New name you want to associate with your record.

name_id: str: Name ID you wish to update.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]: New tags you want to associate with your record.

value: Optional[str]: Value you want to associate with your records, CID or IPNS key.

class scaleway_async.ipfs.v1alpha1.ListNamesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway_async.ipfs.v1alpha1.ListNamesResponse(names: 'List[Name]', total_count: 'int')

Bases: object

names: List[Name]

total_count: int

class scaleway_async.ipfs.v1alpha1.ListPinsRequest(volume_id: 'str', region: 'Optional[Region]', project_id: 'Optional[str]', organization_id: 'Optional[str]', order_by: 'Optional[ListPinsRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]', status: 'Optional[PinStatus]')

Bases: object

order_by: Optional[ListPinsRequestOrderBy]: Sort order of the returned Volume.

organization_id: Optional[str]: Organization ID.

page: Optional[int]: Page number.

page_size: Optional[int]: Maximum number of volumes to return per page.

project_id: Optional[str]: Project ID.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

status: Optional[PinStatus]: List pins by status.

volume_id: str: Volume ID of which you want to list the pins.

class scaleway_async.ipfs.v1alpha1.ListPinsRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway_async.ipfs.v1alpha1.ListPinsResponse(total_count: 'int', pins: 'List[Pin]')

Bases: object

pins: List[Pin]

total_count: int

class scaleway_async.ipfs.v1alpha1.ListVolumesRequest(region: 'Optional[Region]', project_id: 'Optional[str]', order_by: 'Optional[ListVolumesRequestOrderBy]', page: 'Optional[int]', page_size: 'Optional[int]')

Bases: object

order_by: Optional[ListVolumesRequestOrderBy]: Sort the order of the returned volumes.

page: Optional[int]: Page number.

page_size: Optional[int]: Maximum number of volumes to return per page.

project_id: Optional[str]: Project ID, only volumes belonging to this project will be listed.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

class scaleway_async.ipfs.v1alpha1.ListVolumesRequestOrderBy(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CREATED_AT_ASC = 'created_at_asc'

CREATED_AT_DESC = 'created_at_desc'

class scaleway_async.ipfs.v1alpha1.ListVolumesResponse(volumes: 'List[Volume]', total_count: 'int')

Bases: object

total_count: int

volumes: List[Volume]

class scaleway_async.ipfs.v1alpha1.Name(name_id: 'str', project_id: 'str', tags: 'List[str]', name: 'str', key: 'str', status: 'NameStatus', value: 'str', region: 'Region', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]')

Bases: object

created_at: Optional[datetime]

key: str

name: str

name_id: str

project_id: str

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

status: NameStatus

tags: List[str]

updated_at: Optional[datetime]

value: str

class scaleway_async.ipfs.v1alpha1.NameStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

FAILED = 'failed'

PUBLISHED = 'published'

PUBLISHING = 'publishing'

QUEUED = 'queued'

UNKNOWN_STATUS = 'unknown_status'

class scaleway_async.ipfs.v1alpha1.Pin(pin_id: 'str', status: 'PinStatus', delegates: 'List[str]', created_at: 'Optional[datetime]', cid: 'Optional[PinCID]', info: 'Optional[PinInfo]')

Bases: object

cid: Optional[PinCID]

created_at: Optional[datetime]

delegates: List[str]

info: Optional[PinInfo]

pin_id: str

status: PinStatus

class scaleway_async.ipfs.v1alpha1.PinCID(origins: 'List[str]', cid: 'Optional[str]', name: 'Optional[str]', meta: 'Optional[PinCIDMeta]')

Bases: object

cid: Optional[str]

meta: Optional[PinCIDMeta]

name: Optional[str]

origins: List[str]

class scaleway_async.ipfs.v1alpha1.PinCIDMeta(id: 'Optional[str]')

Bases: object

id: Optional[str]

class scaleway_async.ipfs.v1alpha1.PinDetails(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

CHECKING_COHERENCE = 'checking_coherence'

FAILED_CONTAINS_BANNED_CID = 'failed_contains_banned_cid'

FAILED_PINNING = 'failed_pinning'

FAILED_PINNING_BAD_CID_FORMAT = 'failed_pinning_bad_cid_format'

FAILED_PINNING_BAD_URL_FORMAT = 'failed_pinning_bad_url_format'

FAILED_PINNING_BAD_URL_STATUS_CODE = 'failed_pinning_bad_url_status_code'

FAILED_PINNING_NO_PROVIDER = 'failed_pinning_no_provider'

FAILED_PINNING_NO_URL_CONTENT_LENGTH = 'failed_pinning_no_url_content_length'

FAILED_PINNING_TIMEOUT = 'failed_pinning_timeout'

FAILED_PINNING_TOO_BIG_CONTENT = 'failed_pinning_too_big_content'

FAILED_PINNING_UNREACHABLE_URL = 'failed_pinning_unreachable_url'

FAILED_UNPINNING = 'failed_unpinning'

PINNED_OK = 'pinned_ok'

PINNING_BLOCKS_FETCHED = 'pinning_blocks_fetched'

PINNING_FETCHING_URL_DATA = 'pinning_fetching_url_data'

PINNING_IN_PROGRESS = 'pinning_in_progress'

PINNING_LOOKING_FOR_PROVIDER = 'pinning_looking_for_provider'

RESCHEDULED = 'rescheduled'

UNKNOWN_DETAILS = 'unknown_details'

UNPINNED_OK = 'unpinned_ok'

UNPINNING_IN_PROGRESS = 'unpinning_in_progress'

class scaleway_async.ipfs.v1alpha1.PinInfo(status_details: 'PinDetails', id: 'Optional[str]', url: 'Optional[str]', size: 'Optional[int]', progress: 'Optional[int]')

Bases: object

id: Optional[str]

progress: Optional[int]

size: Optional[int]

status_details: PinDetails

url: Optional[str]

class scaleway_async.ipfs.v1alpha1.PinStatus(value: str, names: Optional[Any] = None, *args: Any, **kwargs: Any)

Bases: str, Enum

An enumeration.

FAILED = 'failed'

PINNED = 'pinned'

PINNING = 'pinning'

QUEUED = 'queued'

UNKNOWN_STATUS = 'unknown_status'

class scaleway_async.ipfs.v1alpha1.ReplacePinRequest(volume_id: 'str', pin_id: 'str', cid: 'str', region: 'Optional[Region]', name: 'Optional[str]', origins: 'Optional[List[str]]')

Bases: object

cid: str: New CID you want to pin in place of the old one.

name: Optional[str]: New name to replace.

origins: Optional[List[str]]: Node containing the content you want to pin.

pin_id: str: Pin ID whose information you wish to replace.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

volume_id: str: Volume ID.

class scaleway_async.ipfs.v1alpha1.ReplacePinResponse(pin: 'Optional[Pin]')

Bases: object

pin: Optional[Pin]

class scaleway_async.ipfs.v1alpha1.UpdateVolumeRequest(volume_id: 'str', region: 'Optional[Region]', name: 'Optional[str]', tags: 'Optional[List[str]]')

Bases: object

name: Optional[str]: Volume name.

region: Optional[str]: Region to target. If none is passed will use default region from the config.

tags: Optional[List[str]]: Tags of the volume.

volume_id: str: Volume ID.

class scaleway_async.ipfs.v1alpha1.Volume(id: 'str', project_id: 'str', region: 'Region', count_pin: 'int', tags: 'List[str]', name: 'str', created_at: 'Optional[datetime]', updated_at: 'Optional[datetime]', size: 'Optional[int]')

Bases: object

count_pin: int

created_at: Optional[datetime]

id: str

name: str

project_id: str

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

size: Optional[int]

tags: List[str]

updated_at: Optional[datetime]