Skip to content

FilesystemsApi.md

Latest commit

 

History

History
168 lines (119 loc) · 5.68 KB

FilesystemsApi.md

File metadata and controls

168 lines (119 loc) · 5.68 KB

openapi.api.FilesystemsApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to https://cloud.lambda.ai

Method HTTP request Description
createFilesystem POST /api/v1/filesystems Create filesystem
filesystemDelete DELETE /api/v1/filesystems/{id} Delete filesystem
listFilesystems GET /api/v1/file-systems List filesystems

createFilesystem

CreateFilesystem200Response createFilesystem(filesystemCreateRequest)

Create filesystem

Creates a new filesystem.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';
// TODO Configure HTTP Bearer authorization: bearerAuth
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FilesystemsApi();
final filesystemCreateRequest = FilesystemCreateRequest(); // FilesystemCreateRequest | 

try {
    final result = api_instance.createFilesystem(filesystemCreateRequest);
    print(result);
} catch (e) {
    print('Exception when calling FilesystemsApi->createFilesystem: $e\n');
}

Parameters

Name Type Description Notes
filesystemCreateRequest FilesystemCreateRequest

Return type

CreateFilesystem200Response

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

filesystemDelete

FilesystemDelete200Response filesystemDelete(id)

Delete filesystem

Deletes the filesystem with the specified ID. The filesystem must not be mounted to any running instances at the time of deletion.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';
// TODO Configure HTTP Bearer authorization: bearerAuth
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FilesystemsApi();
final id = 398578a2336b49079e74043f0bd2cfe8; // String | The unique identifier (ID) of the filesystem to delete

try {
    final result = api_instance.filesystemDelete(id);
    print(result);
} catch (e) {
    print('Exception when calling FilesystemsApi->filesystemDelete: $e\n');
}

Parameters

Name Type Description Notes
id String The unique identifier (ID) of the filesystem to delete

Return type

FilesystemDelete200Response

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listFilesystems

ListFilesystems200Response listFilesystems()

List filesystems

Retrieves a list of your filesystems.

Example

import 'package:openapi/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';
// TODO Configure HTTP Bearer authorization: bearerAuth
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken(yourTokenGeneratorFunction);

final api_instance = FilesystemsApi();

try {
    final result = api_instance.listFilesystems();
    print(result);
} catch (e) {
    print('Exception when calling FilesystemsApi->listFilesystems: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

ListFilesystems200Response

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]