Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 9.75 KB

RoleBindingV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 9.75 KB

halo_client.api.RoleBindingV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createRoleBinding POST /api/v1alpha1/rolebindings
deleteRoleBinding DELETE /api/v1alpha1/rolebindings/{name}
getRoleBinding GET /api/v1alpha1/rolebindings/{name}
listRoleBinding GET /api/v1alpha1/rolebindings
patchRoleBinding PATCH /api/v1alpha1/rolebindings/{name}
updateRoleBinding PUT /api/v1alpha1/rolebindings/{name}

createRoleBinding

RoleBinding createRoleBinding(roleBinding)

Create RoleBinding

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().getRoleBindingV1alpha1Api();
final RoleBinding roleBinding = ; // RoleBinding | Fresh rolebinding

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

Parameters

Name Type Description Notes
roleBinding RoleBinding Fresh rolebinding [optional]

Return type

RoleBinding

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]

deleteRoleBinding

deleteRoleBinding(name)

Delete RoleBinding

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

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

Parameters

Name Type Description Notes
name String Name of rolebinding

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]

getRoleBinding

RoleBinding getRoleBinding(name)

Get RoleBinding

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

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

Parameters

Name Type Description Notes
name String Name of rolebinding

Return type

RoleBinding

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]

listRoleBinding

RoleBindingList listRoleBinding(page, size, labelSelector, fieldSelector, sort)

List RoleBinding

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

RoleBindingList

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]

patchRoleBinding

RoleBinding patchRoleBinding(name, jsonPatchInner)

Patch RoleBinding

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

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

Parameters

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

Return type

RoleBinding

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]

updateRoleBinding

RoleBinding updateRoleBinding(name, roleBinding)

Update RoleBinding

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().getRoleBindingV1alpha1Api();
final String name = name_example; // String | Name of rolebinding
final RoleBinding roleBinding = ; // RoleBinding | Updated rolebinding

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

Parameters

Name Type Description Notes
name String Name of rolebinding
roleBinding RoleBinding Updated rolebinding [optional]

Return type

RoleBinding

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]