Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 10.2 KB

PolicyTemplateV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 10.2 KB

halo_client.api.PolicyTemplateV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createPolicyTemplate POST /apis/storage.halo.run/v1alpha1/policytemplates
deletePolicyTemplate DELETE /apis/storage.halo.run/v1alpha1/policytemplates/{name}
getPolicyTemplate GET /apis/storage.halo.run/v1alpha1/policytemplates/{name}
listPolicyTemplate GET /apis/storage.halo.run/v1alpha1/policytemplates
patchPolicyTemplate PATCH /apis/storage.halo.run/v1alpha1/policytemplates/{name}
updatePolicyTemplate PUT /apis/storage.halo.run/v1alpha1/policytemplates/{name}

createPolicyTemplate

PolicyTemplate createPolicyTemplate(policyTemplate)

Create PolicyTemplate

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().getPolicyTemplateV1alpha1Api();
final PolicyTemplate policyTemplate = ; // PolicyTemplate | Fresh policytemplate

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

Parameters

Name Type Description Notes
policyTemplate PolicyTemplate Fresh policytemplate [optional]

Return type

PolicyTemplate

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]

deletePolicyTemplate

deletePolicyTemplate(name)

Delete PolicyTemplate

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().getPolicyTemplateV1alpha1Api();
final String name = name_example; // String | Name of policytemplate

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

Parameters

Name Type Description Notes
name String Name of policytemplate

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]

getPolicyTemplate

PolicyTemplate getPolicyTemplate(name)

Get PolicyTemplate

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().getPolicyTemplateV1alpha1Api();
final String name = name_example; // String | Name of policytemplate

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

Parameters

Name Type Description Notes
name String Name of policytemplate

Return type

PolicyTemplate

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]

listPolicyTemplate

PolicyTemplateList listPolicyTemplate(page, size, labelSelector, fieldSelector, sort)

List PolicyTemplate

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().getPolicyTemplateV1alpha1Api();
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.listPolicyTemplate(page, size, labelSelector, fieldSelector, sort);
    print(response);
} catch on DioException (e) {
    print('Exception when calling PolicyTemplateV1alpha1Api->listPolicyTemplate: $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

PolicyTemplateList

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]

patchPolicyTemplate

PolicyTemplate patchPolicyTemplate(name, jsonPatchInner)

Patch PolicyTemplate

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().getPolicyTemplateV1alpha1Api();
final String name = name_example; // String | Name of policytemplate
final BuiltSet<JsonPatchInner> jsonPatchInner = ; // BuiltSet<JsonPatchInner> | 

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

Parameters

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

Return type

PolicyTemplate

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]

updatePolicyTemplate

PolicyTemplate updatePolicyTemplate(name, policyTemplate)

Update PolicyTemplate

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().getPolicyTemplateV1alpha1Api();
final String name = name_example; // String | Name of policytemplate
final PolicyTemplate policyTemplate = ; // PolicyTemplate | Updated policytemplate

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

Parameters

Name Type Description Notes
name String Name of policytemplate
policyTemplate PolicyTemplate Updated policytemplate [optional]

Return type

PolicyTemplate

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]