scaleway-block-storage/test/Api/SnapshotApiTest.php

169 lines
12 KiB
PHP
Raw Permalink Normal View History

2025-03-03 16:35:54 +01:00
<?php
/**
* SnapshotApiTest
* PHP version 7.4
*
* @category Class
* @package OpenAPI\Client
* @author OpenAPI Generator team
* @link https://openapi-generator.tech
*/
/**
* Block Storage API
*
* Scaleway Block Storage provides network-attached storage that can be plugged in and out of cloud products such as Instances like a virtual hard-drive. Block Storage devices are independent from the local storage of Instances, and the fact that they are accessed over a network connection makes it easy to move them between Instances in the same Availability Zone. (switchcolumn) <Message type=\"important\"> This page includes the API reference documentation for all Block Storage Low Latency offers. If you wish to use the Basic Block Storage offers, refer to the [Instances API documentation page](/api/instance/#path-volume-types-list-volume-types). </Message> (switchcolumn) ## Quickstart 1. Configure your environment variables. <Message type=\"note\"> This is an optional step that seeks to simplify your usage of the Block Storage API. See [Availability Zones](#availability-zones) below for help choosing an Availability Zone. You can find your Project ID in the [Scaleway console](https://console.scaleway.com/project/settings). </Message> ```bash export SCW_SECRET_KEY=\"<API secret key>\" export SCW_DEFAULT_ZONE=\"<Scaleway Availability Zone>\" export SCW_PROJECT_ID=\"<Scaleway Project ID>\" ``` <Message type=\"important\"> Make sure that the Availability Zone (AZ) is the same as the one of your Instance. Block volumes can only be attached to Instances in the same AZ. </Message> 2. Edit the POST request payload you will use to create your Block volume. Replace the parameters in the following example: ```json '{ \"project_id\": \"d8e65f2b-cce9-40b7-80fc-6a2902db6826\", \"name\": \"my-volume\", \"perf_iops\": \"5000\", \"tags\": [\"donnerstag\"], \"from_empty\": { \"size\": \"30000000000\"} }' ``` | Parameter | Description | | :----------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `project_id` | **REQUIRED** The ID of the Project you want to create your Block volume in. To find your Project ID you can **[list the projects](/api/account#path-projects-list-all-projects-of-an-organization)** or consult the **[Scaleway console](https://console.scaleway.com/project/settings)**. | | `name` | **REQUIRED** Name of the volume | | `perf_iops` | **REQUIRED** The maximum IO/s expected. This amount is a shared limit between write and read operations, it will be determined by your usage. You must specify either `5000`, or `15000`. | | `tags` | The list of tags `[\"tag1\", \"tag2\", ...]` that will be associated with the Database Instance. Tags can be appended to the query of the [List Database Instances](#path-database-instances-list-database-instances) call to show results for only th
*
* The version of the OpenAPI document: v1alpha1
* Generated by: https://openapi-generator.tech
* Generator version: 7.11.0
*/
/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Please update the test case below to test the endpoint.
*/
namespace OpenAPI\Client\Test\Api;
use \OpenAPI\Client\Configuration;
use \OpenAPI\Client\ApiException;
use \OpenAPI\Client\ObjectSerializer;
use PHPUnit\Framework\TestCase;
/**
* SnapshotApiTest Class Doc Comment
*
* @category Class
* @package OpenAPI\Client
* @author OpenAPI Generator team
* @link https://openapi-generator.tech
*/
class SnapshotApiTest extends TestCase
{
/**
* Setup before running any test cases
*/
public static function setUpBeforeClass(): void
{
}
/**
* Setup before running each test case
*/
public function setUp(): void
{
}
/**
* Clean up after running each test case
*/
public function tearDown(): void
{
}
/**
* Clean up after running all test cases
*/
public static function tearDownAfterClass(): void
{
}
/**
* Test case for createSnapshot
*
* Create a snapshot of a volume.
*
*/
public function testCreateSnapshot()
{
// TODO: implement
self::markTestIncomplete('Not implemented');
}
/**
* Test case for deleteSnapshot
*
* Delete a snapshot.
*
*/
public function testDeleteSnapshot()
{
// TODO: implement
self::markTestIncomplete('Not implemented');
}
/**
* Test case for exportSnapshotToObjectStorage
*
* Export a snapshot to a Scaleway Object Storage bucket.
*
*/
public function testExportSnapshotToObjectStorage()
{
// TODO: implement
self::markTestIncomplete('Not implemented');
}
/**
* Test case for getSnapshot
*
* Get a snapshot.
*
*/
public function testGetSnapshot()
{
// TODO: implement
self::markTestIncomplete('Not implemented');
}
/**
* Test case for importSnapshotFromObjectStorage
*
* Import a snapshot from a Scaleway Object Storage bucket.
*
*/
public function testImportSnapshotFromObjectStorage()
{
// TODO: implement
self::markTestIncomplete('Not implemented');
}
/**
* Test case for importSnapshotFromS3
*
* (Deprecated in favor of `ImportSnapshotFromObjectStorage`).
*
*/
public function testImportSnapshotFromS3()
{
// TODO: implement
self::markTestIncomplete('Not implemented');
}
/**
* Test case for listSnapshots
*
* List all snapshots.
*
*/
public function testListSnapshots()
{
// TODO: implement
self::markTestIncomplete('Not implemented');
}
/**
* Test case for updateSnapshot
*
* Update a snapshot.
*
*/
public function testUpdateSnapshot()
{
// TODO: implement
self::markTestIncomplete('Not implemented');
}
}