Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 10.6 KB

NotifierDescriptorV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 10.6 KB

halo_client.api.NotifierDescriptorV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createNotifierDescriptor POST /apis/notification.halo.run/v1alpha1/notifierDescriptors
deleteNotifierDescriptor DELETE /apis/notification.halo.run/v1alpha1/notifierDescriptors/{name}
getNotifierDescriptor GET /apis/notification.halo.run/v1alpha1/notifierDescriptors/{name}
listNotifierDescriptor GET /apis/notification.halo.run/v1alpha1/notifierDescriptors
patchNotifierDescriptor PATCH /apis/notification.halo.run/v1alpha1/notifierDescriptors/{name}
updateNotifierDescriptor PUT /apis/notification.halo.run/v1alpha1/notifierDescriptors/{name}

createNotifierDescriptor

NotifierDescriptor createNotifierDescriptor(notifierDescriptor)

Create NotifierDescriptor

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().getNotifierDescriptorV1alpha1Api();
final NotifierDescriptor notifierDescriptor = ; // NotifierDescriptor | Fresh notifierDescriptor

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

Parameters

Name Type Description Notes
notifierDescriptor NotifierDescriptor Fresh notifierDescriptor [optional]

Return type

NotifierDescriptor

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]

deleteNotifierDescriptor

deleteNotifierDescriptor(name)

Delete NotifierDescriptor

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

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

Parameters

Name Type Description Notes
name String Name of notifierDescriptor

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]

getNotifierDescriptor

NotifierDescriptor getNotifierDescriptor(name)

Get NotifierDescriptor

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

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

Parameters

Name Type Description Notes
name String Name of notifierDescriptor

Return type

NotifierDescriptor

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]

listNotifierDescriptor

NotifierDescriptorList listNotifierDescriptor(page, size, labelSelector, fieldSelector, sort)

List NotifierDescriptor

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

NotifierDescriptorList

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]

patchNotifierDescriptor

NotifierDescriptor patchNotifierDescriptor(name, jsonPatchInner)

Patch NotifierDescriptor

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

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

Parameters

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

Return type

NotifierDescriptor

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]

updateNotifierDescriptor

NotifierDescriptor updateNotifierDescriptor(name, notifierDescriptor)

Update NotifierDescriptor

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().getNotifierDescriptorV1alpha1Api();
final String name = name_example; // String | Name of notifierDescriptor
final NotifierDescriptor notifierDescriptor = ; // NotifierDescriptor | Updated notifierDescriptor

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

Parameters

Name Type Description Notes
name String Name of notifierDescriptor
notifierDescriptor NotifierDescriptor Updated notifierDescriptor [optional]

Return type

NotifierDescriptor

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]