Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 9.33 KB

BackupV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 9.33 KB

halo_client.api.BackupV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

All URIs are relative to http://localhost:8091

Method HTTP request Description
createBackup POST /apis/migration.halo.run/v1alpha1/backups
deleteBackup DELETE /apis/migration.halo.run/v1alpha1/backups/{name}
getBackup GET /apis/migration.halo.run/v1alpha1/backups/{name}
listBackup GET /apis/migration.halo.run/v1alpha1/backups
patchBackup PATCH /apis/migration.halo.run/v1alpha1/backups/{name}
updateBackup PUT /apis/migration.halo.run/v1alpha1/backups/{name}

createBackup

Backup createBackup(backup)

Create Backup

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getBackupV1alpha1Api();
final Backup backup = ; // Backup | Fresh backup

try {
    final response = api.createBackup(backup);
    print(response);
} catch on DioException (e) {
    print('Exception when calling BackupV1alpha1Api->createBackup: $e\n');
}

Parameters

Name Type Description Notes
backup Backup Fresh backup [optional]

Return type

Backup

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

deleteBackup

deleteBackup(name)

Delete Backup

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getBackupV1alpha1Api();
final String name = name_example; // String | Name of backup

try {
    api.deleteBackup(name);
} catch on DioException (e) {
    print('Exception when calling BackupV1alpha1Api->deleteBackup: $e\n');
}

Parameters

Name Type Description Notes
name String Name of backup

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getBackup

Backup getBackup(name)

Get Backup

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getBackupV1alpha1Api();
final String name = name_example; // String | Name of backup

try {
    final response = api.getBackup(name);
    print(response);
} catch on DioException (e) {
    print('Exception when calling BackupV1alpha1Api->getBackup: $e\n');
}

Parameters

Name Type Description Notes
name String Name of backup

Return type

Backup

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

listBackup

BackupList listBackup(page, size, labelSelector, fieldSelector, sort)

List Backup

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getBackupV1alpha1Api();
final int page = 56; // int | Page number. Default is 0.
final int size = 56; // int | Size number. Default is 0.
final BuiltList<String> labelSelector = ; // BuiltList<String> | Label selector. e.g.: hidden!=true
final BuiltList<String> fieldSelector = ; // BuiltList<String> | Field selector. e.g.: metadata.name==halo
final BuiltList<String> sort = ; // BuiltList<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

try {
    final response = api.listBackup(page, size, labelSelector, fieldSelector, sort);
    print(response);
} catch on DioException (e) {
    print('Exception when calling BackupV1alpha1Api->listBackup: $e\n');
}

Parameters

Name Type Description Notes
page int Page number. Default is 0. [optional]
size int Size number. Default is 0. [optional]
labelSelector BuiltList<String> Label selector. e.g.: hidden!=true [optional]
fieldSelector BuiltList<String> Field selector. e.g.: metadata.name==halo [optional]
sort BuiltList<String> Sorting criteria in the format: property,(asc desc). Default sort order is ascending. Multiple sort criteria are supported.

Return type

BackupList

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

patchBackup

Backup patchBackup(name, jsonPatchInner)

Patch Backup

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getBackupV1alpha1Api();
final String name = name_example; // String | Name of backup
final BuiltSet<JsonPatchInner> jsonPatchInner = ; // BuiltSet<JsonPatchInner> | 

try {
    final response = api.patchBackup(name, jsonPatchInner);
    print(response);
} catch on DioException (e) {
    print('Exception when calling BackupV1alpha1Api->patchBackup: $e\n');
}

Parameters

Name Type Description Notes
name String Name of backup
jsonPatchInner BuiltSet<JsonPatchInner> [optional]

Return type

Backup

Authorization

basicAuth, bearerAuth

HTTP request headers

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

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

updateBackup

Backup updateBackup(name, backup)

Update Backup

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getBackupV1alpha1Api();
final String name = name_example; // String | Name of backup
final Backup backup = ; // Backup | Updated backup

try {
    final response = api.updateBackup(name, backup);
    print(response);
} catch on DioException (e) {
    print('Exception when calling BackupV1alpha1Api->updateBackup: $e\n');
}

Parameters

Name Type Description Notes
name String Name of backup
backup Backup Updated backup [optional]

Return type

Backup

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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